GetClusterSummaryLifecycleStateEnumValues Enumerates the set of values for ClusterLifecycleStateEnum Consider using GetClusterLifecycleStateEnumValue Deprecated
var GetClusterSummaryLifecycleStateEnumValues = GetClusterLifecycleStateEnumValues
GetWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum Consider using GetWorkRequestOperationTypeEnumValue Deprecated
var GetWorkRequestSummaryOperationTypeEnumValues = GetWorkRequestOperationTypeEnumValues
GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum Consider using GetWorkRequestStatusEnumValue Deprecated
var GetWorkRequestSummaryStatusEnumValues = GetWorkRequestStatusEnumValues
func GetAddonLifecycleStateEnumStringValues() []string
GetAddonLifecycleStateEnumStringValues Enumerates the set of values in String for AddonLifecycleStateEnum
func GetAddonOptionSummaryLifecycleStateEnumStringValues() []string
GetAddonOptionSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for AddonOptionSummaryLifecycleStateEnum
func GetAddonVersionsStatusEnumStringValues() []string
GetAddonVersionsStatusEnumStringValues Enumerates the set of values in String for AddonVersionsStatusEnum
func GetClusterCreateOptionsIpFamiliesEnumStringValues() []string
GetClusterCreateOptionsIpFamiliesEnumStringValues Enumerates the set of values in String for ClusterCreateOptionsIpFamiliesEnum
func GetClusterLifecycleStateEnumStringValues() []string
GetClusterLifecycleStateEnumStringValues Enumerates the set of values in String for ClusterLifecycleStateEnum
func GetClusterMigrateToNativeVcnStatusStateEnumStringValues() []string
GetClusterMigrateToNativeVcnStatusStateEnumStringValues Enumerates the set of values in String for ClusterMigrateToNativeVcnStatusStateEnum
func GetClusterPodNetworkOptionDetailsCniTypeEnumStringValues() []string
GetClusterPodNetworkOptionDetailsCniTypeEnumStringValues Enumerates the set of values in String for ClusterPodNetworkOptionDetailsCniTypeEnum
func GetClusterTypeEnumStringValues() []string
GetClusterTypeEnumStringValues Enumerates the set of values in String for ClusterTypeEnum
func GetCreateClusterKubeconfigContentDetailsEndpointEnumStringValues() []string
GetCreateClusterKubeconfigContentDetailsEndpointEnumStringValues Enumerates the set of values in String for CreateClusterKubeconfigContentDetailsEndpointEnum
func GetCredentialRotationStatusStatusDetailsEnumStringValues() []string
GetCredentialRotationStatusStatusDetailsEnumStringValues Enumerates the set of values in String for CredentialRotationStatusStatusDetailsEnum
func GetCredentialRotationStatusStatusEnumStringValues() []string
GetCredentialRotationStatusStatusEnumStringValues Enumerates the set of values in String for CredentialRotationStatusStatusEnum
func GetListAddonOptionsSortByEnumStringValues() []string
GetListAddonOptionsSortByEnumStringValues Enumerates the set of values in String for ListAddonOptionsSortByEnum
func GetListAddonOptionsSortOrderEnumStringValues() []string
GetListAddonOptionsSortOrderEnumStringValues Enumerates the set of values in String for ListAddonOptionsSortOrderEnum
func GetListAddonsSortByEnumStringValues() []string
GetListAddonsSortByEnumStringValues Enumerates the set of values in String for ListAddonsSortByEnum
func GetListAddonsSortOrderEnumStringValues() []string
GetListAddonsSortOrderEnumStringValues Enumerates the set of values in String for ListAddonsSortOrderEnum
func GetListClustersSortByEnumStringValues() []string
GetListClustersSortByEnumStringValues Enumerates the set of values in String for ListClustersSortByEnum
func GetListClustersSortOrderEnumStringValues() []string
GetListClustersSortOrderEnumStringValues Enumerates the set of values in String for ListClustersSortOrderEnum
func GetListNodePoolsSortByEnumStringValues() []string
GetListNodePoolsSortByEnumStringValues Enumerates the set of values in String for ListNodePoolsSortByEnum
func GetListNodePoolsSortOrderEnumStringValues() []string
GetListNodePoolsSortOrderEnumStringValues Enumerates the set of values in String for ListNodePoolsSortOrderEnum
func GetListPodShapesSortByEnumStringValues() []string
GetListPodShapesSortByEnumStringValues Enumerates the set of values in String for ListPodShapesSortByEnum
func GetListPodShapesSortOrderEnumStringValues() []string
GetListPodShapesSortOrderEnumStringValues Enumerates the set of values in String for ListPodShapesSortOrderEnum
func GetListVirtualNodePoolsSortByEnumStringValues() []string
GetListVirtualNodePoolsSortByEnumStringValues Enumerates the set of values in String for ListVirtualNodePoolsSortByEnum
func GetListVirtualNodePoolsSortOrderEnumStringValues() []string
GetListVirtualNodePoolsSortOrderEnumStringValues Enumerates the set of values in String for ListVirtualNodePoolsSortOrderEnum
func GetListVirtualNodesSortByEnumStringValues() []string
GetListVirtualNodesSortByEnumStringValues Enumerates the set of values in String for ListVirtualNodesSortByEnum
func GetListVirtualNodesSortOrderEnumStringValues() []string
GetListVirtualNodesSortOrderEnumStringValues Enumerates the set of values in String for ListVirtualNodesSortOrderEnum
func GetListWorkRequestsResourceTypeEnumStringValues() []string
GetListWorkRequestsResourceTypeEnumStringValues Enumerates the set of values in String for ListWorkRequestsResourceTypeEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkloadMappingsSortByEnumStringValues() []string
GetListWorkloadMappingsSortByEnumStringValues Enumerates the set of values in String for ListWorkloadMappingsSortByEnum
func GetListWorkloadMappingsSortOrderEnumStringValues() []string
GetListWorkloadMappingsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkloadMappingsSortOrderEnum
func GetNodeLifecycleStateEnumStringValues() []string
GetNodeLifecycleStateEnumStringValues Enumerates the set of values in String for NodeLifecycleStateEnum
func GetNodePoolLifecycleStateEnumStringValues() []string
GetNodePoolLifecycleStateEnumStringValues Enumerates the set of values in String for NodePoolLifecycleStateEnum
func GetNodePoolPodNetworkOptionDetailsCniTypeEnumStringValues() []string
GetNodePoolPodNetworkOptionDetailsCniTypeEnumStringValues Enumerates the set of values in String for NodePoolPodNetworkOptionDetailsCniTypeEnum
func GetNodeSourceTypeEnumStringValues() []string
GetNodeSourceTypeEnumStringValues Enumerates the set of values in String for NodeSourceTypeEnum
func GetPreemptionActionTypeEnumStringValues() []string
GetPreemptionActionTypeEnumStringValues Enumerates the set of values in String for PreemptionActionTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetVirtualNodeLifecycleStateEnumStringValues() []string
GetVirtualNodeLifecycleStateEnumStringValues Enumerates the set of values in String for VirtualNodeLifecycleStateEnum
func GetVirtualNodePoolLifecycleStateEnumStringValues() []string
GetVirtualNodePoolLifecycleStateEnumStringValues Enumerates the set of values in String for VirtualNodePoolLifecycleStateEnum
func GetWorkRequestOperationTypeEnumStringValues() []string
GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum
func GetWorkRequestResourceActionTypeEnumStringValues() []string
GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum
func GetWorkRequestStatusEnumStringValues() []string
GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum
func GetWorkloadMappingLifecycleStateEnumStringValues() []string
GetWorkloadMappingLifecycleStateEnumStringValues Enumerates the set of values in String for WorkloadMappingLifecycleStateEnum
AddOnOptions The properties that define options for supported add-ons.
type AddOnOptions struct {
// Whether or not to enable the Kubernetes Dashboard add-on.
IsKubernetesDashboardEnabled *bool `mandatory:"false" json:"isKubernetesDashboardEnabled"`
// Whether or not to enable the Tiller add-on.
IsTillerEnabled *bool `mandatory:"false" json:"isTillerEnabled"`
}
func (m AddOnOptions) String() string
func (m AddOnOptions) 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
Addon The properties that define an addon.
type Addon struct {
// The name of the addon.
Name *string `mandatory:"true" json:"name"`
// The state of the addon.
LifecycleState AddonLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// selected addon version, or null indicates autoUpdate
Version *string `mandatory:"false" json:"version"`
// current installed version of the addon
CurrentInstalledVersion *string `mandatory:"false" json:"currentInstalledVersion"`
// The time the cluster was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Addon configuration details.
Configurations []AddonConfiguration `mandatory:"false" json:"configurations"`
// The error info of the addon.
AddonError *AddonError `mandatory:"false" json:"addonError"`
}
func (m Addon) String() string
func (m Addon) 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
AddonConfiguration Defines the configuration of available addons for a cluster
type AddonConfiguration struct {
// configuration key name
Key *string `mandatory:"false" json:"key"`
// configuration value name
Value *string `mandatory:"false" json:"value"`
}
func (m AddonConfiguration) String() string
func (m AddonConfiguration) 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
AddonError The error info of the addon.
type AddonError struct {
// A short error code that defines the upstream error, meant for programmatic parsing. See API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"false" json:"code"`
// A human-readable error string of the upstream error.
Message *string `mandatory:"false" json:"message"`
// The status of the HTTP response encountered in the upstream error.
Status *string `mandatory:"false" json:"status"`
}
func (m AddonError) String() string
func (m AddonError) 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
AddonLifecycleStateEnum Enum with underlying type: string
type AddonLifecycleStateEnum string
Set of constants representing the allowable values for AddonLifecycleStateEnum
const (
AddonLifecycleStateCreating AddonLifecycleStateEnum = "CREATING"
AddonLifecycleStateActive AddonLifecycleStateEnum = "ACTIVE"
AddonLifecycleStateDeleting AddonLifecycleStateEnum = "DELETING"
AddonLifecycleStateDeleted AddonLifecycleStateEnum = "DELETED"
AddonLifecycleStateUpdating AddonLifecycleStateEnum = "UPDATING"
AddonLifecycleStateNeedsAttention AddonLifecycleStateEnum = "NEEDS_ATTENTION"
AddonLifecycleStateFailed AddonLifecycleStateEnum = "FAILED"
)
func GetAddonLifecycleStateEnumValues() []AddonLifecycleStateEnum
GetAddonLifecycleStateEnumValues Enumerates the set of values for AddonLifecycleStateEnum
func GetMappingAddonLifecycleStateEnum(val string) (AddonLifecycleStateEnum, bool)
GetMappingAddonLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AddonOptionSummary The properties that define addon summary.
type AddonOptionSummary struct {
// Name of the addon and it would be unique.
Name *string `mandatory:"true" json:"name"`
// The life cycle state of the addon.
LifecycleState AddonOptionSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Is it an essential addon for cluster operation or not.
IsEssential *bool `mandatory:"true" json:"isEssential"`
// The resources this work request affects.
Versions []AddonVersions `mandatory:"true" json:"versions"`
// Addon definition schema version to validate addon.
AddonSchemaVersion *string `mandatory:"false" json:"addonSchemaVersion"`
// Addon group info, a namespace concept that groups addons with similar functionalities.
AddonGroup *string `mandatory:"false" json:"addonGroup"`
// Description on the addon.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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 time the work request was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m AddonOptionSummary) String() string
func (m AddonOptionSummary) 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
AddonOptionSummaryLifecycleStateEnum Enum with underlying type: string
type AddonOptionSummaryLifecycleStateEnum string
Set of constants representing the allowable values for AddonOptionSummaryLifecycleStateEnum
const (
AddonOptionSummaryLifecycleStateActive AddonOptionSummaryLifecycleStateEnum = "ACTIVE"
AddonOptionSummaryLifecycleStateInactive AddonOptionSummaryLifecycleStateEnum = "INACTIVE"
)
func GetAddonOptionSummaryLifecycleStateEnumValues() []AddonOptionSummaryLifecycleStateEnum
GetAddonOptionSummaryLifecycleStateEnumValues Enumerates the set of values for AddonOptionSummaryLifecycleStateEnum
func GetMappingAddonOptionSummaryLifecycleStateEnum(val string) (AddonOptionSummaryLifecycleStateEnum, bool)
GetMappingAddonOptionSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AddonSummary The properties that define an addon summary.
type AddonSummary struct {
// The name of the addon.
Name *string `mandatory:"true" json:"name"`
// The state of the addon.
LifecycleState AddonLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// selected addon version, or null indicates autoUpdate
Version *string `mandatory:"false" json:"version"`
// current installed version of the addon
CurrentInstalledVersion *string `mandatory:"false" json:"currentInstalledVersion"`
// The time the cluster was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The error info of the addon.
AddonError *AddonError `mandatory:"false" json:"addonError"`
}
func (m AddonSummary) String() string
func (m AddonSummary) 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
AddonVersionConfiguration Addon version configuration details.
type AddonVersionConfiguration struct {
// If the the configuration is required or not.
IsRequired *bool `mandatory:"false" json:"isRequired"`
// Addon configuration key
Key *string `mandatory:"false" json:"key"`
// Addon configuration value
Value *string `mandatory:"false" json:"value"`
// Display name of addon version.
DisplayName *string `mandatory:"false" json:"displayName"`
// Information about the addon version configuration.
Description *string `mandatory:"false" json:"description"`
}
func (m AddonVersionConfiguration) String() string
func (m AddonVersionConfiguration) 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
AddonVersions The properties that define a work request resource.
type AddonVersions struct {
// Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property.
Status AddonVersionsStatusEnum `mandatory:"false" json:"status,omitempty"`
// Version number, need be comparable within an addon.
VersionNumber *string `mandatory:"false" json:"versionNumber"`
// Information about the addon version.
Description *string `mandatory:"false" json:"description"`
// The range of kubernetes versions an addon can be configured.
KubernetesVersionFilters *KubernetesVersionsFilters `mandatory:"false" json:"kubernetesVersionFilters"`
// Addon version configuration details.
Configurations []AddonVersionConfiguration `mandatory:"false" json:"configurations"`
}
func (m AddonVersions) String() string
func (m AddonVersions) 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
AddonVersionsStatusEnum Enum with underlying type: string
type AddonVersionsStatusEnum string
Set of constants representing the allowable values for AddonVersionsStatusEnum
const (
AddonVersionsStatusActive AddonVersionsStatusEnum = "ACTIVE"
AddonVersionsStatusDeprecated AddonVersionsStatusEnum = "DEPRECATED"
AddonVersionsStatusPreview AddonVersionsStatusEnum = "PREVIEW"
AddonVersionsStatusRecalled AddonVersionsStatusEnum = "RECALLED"
)
func GetAddonVersionsStatusEnumValues() []AddonVersionsStatusEnum
GetAddonVersionsStatusEnumValues Enumerates the set of values for AddonVersionsStatusEnum
func GetMappingAddonVersionsStatusEnum(val string) (AddonVersionsStatusEnum, bool)
GetMappingAddonVersionsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
AdmissionControllerOptions The properties that define supported admission controllers.
type AdmissionControllerOptions struct {
// Whether or not to enable the Pod Security Policy admission controller.
IsPodSecurityPolicyEnabled *bool `mandatory:"false" json:"isPodSecurityPolicyEnabled"`
}
func (m AdmissionControllerOptions) String() string
func (m AdmissionControllerOptions) 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
Cluster A Kubernetes cluster. Avoid entering confidential information.
type Cluster struct {
// The OCID of the cluster.
Id *string `mandatory:"false" json:"id"`
// The name of the cluster.
Name *string `mandatory:"false" json:"name"`
// The OCID of the compartment in which the cluster exists.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The network configuration for access to the Cluster control plane.
EndpointConfig *ClusterEndpointConfig `mandatory:"false" json:"endpointConfig"`
// The OCID of the virtual cloud network (VCN) in which the cluster exists.
VcnId *string `mandatory:"false" json:"vcnId"`
// The version of Kubernetes running on the cluster masters.
KubernetesVersion *string `mandatory:"false" json:"kubernetesVersion"`
// The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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"`
// Optional attributes for the cluster.
Options *ClusterCreateOptions `mandatory:"false" json:"options"`
// Metadata about the cluster.
Metadata *ClusterMetadata `mandatory:"false" json:"metadata"`
// The state of the cluster masters. For more information, see Monitoring Clusters (https://docs.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm)
LifecycleState ClusterLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Details about the state of the cluster masters.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Endpoints served up by the cluster masters.
Endpoints *ClusterEndpoints `mandatory:"false" json:"endpoints"`
// Available Kubernetes versions to which the clusters masters may be upgraded.
AvailableKubernetesUpgrades []string `mandatory:"false" json:"availableKubernetesUpgrades"`
// The image verification policy for signature validation.
ImagePolicyConfig *ImagePolicyConfig `mandatory:"false" json:"imagePolicyConfig"`
// Available CNIs and network options for existing and new node pools of the cluster
ClusterPodNetworkOptions []ClusterPodNetworkOptionDetails `mandatory:"false" json:"clusterPodNetworkOptions"`
// Type of cluster
Type ClusterTypeEnum `mandatory:"false" json:"type,omitempty"`
// The cluster-specific OpenID Connect Discovery endpoint
OpenIdConnectDiscoveryEndpoint *string `mandatory:"false" json:"openIdConnectDiscoveryEndpoint"`
}
func (m Cluster) String() string
func (m *Cluster) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Cluster) 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
ClusterCreateOptions The properties that define extra options for a cluster.
type ClusterCreateOptions struct {
// The OCIDs of the subnets used for Kubernetes services load balancers.
ServiceLbSubnetIds []string `mandatory:"false" json:"serviceLbSubnetIds"`
// IP family to use for single stack or define the order of IP families for dual-stack
IpFamilies []ClusterCreateOptionsIpFamiliesEnum `mandatory:"false" json:"ipFamilies,omitempty"`
// Network configuration for Kubernetes.
KubernetesNetworkConfig *KubernetesNetworkConfig `mandatory:"false" json:"kubernetesNetworkConfig"`
// Configurable cluster add-ons
AddOns *AddOnOptions `mandatory:"false" json:"addOns"`
// Configurable cluster admission controllers
AdmissionControllerOptions *AdmissionControllerOptions `mandatory:"false" json:"admissionControllerOptions"`
PersistentVolumeConfig *PersistentVolumeConfigDetails `mandatory:"false" json:"persistentVolumeConfig"`
ServiceLbConfig *ServiceLbConfigDetails `mandatory:"false" json:"serviceLbConfig"`
OpenIdConnectTokenAuthenticationConfig *OpenIdConnectTokenAuthenticationConfig `mandatory:"false" json:"openIdConnectTokenAuthenticationConfig"`
OpenIdConnectDiscovery *OpenIdConnectDiscovery `mandatory:"false" json:"openIdConnectDiscovery"`
}
func (m ClusterCreateOptions) String() string
func (m ClusterCreateOptions) 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
ClusterCreateOptionsIpFamiliesEnum Enum with underlying type: string
type ClusterCreateOptionsIpFamiliesEnum string
Set of constants representing the allowable values for ClusterCreateOptionsIpFamiliesEnum
const (
ClusterCreateOptionsIpFamiliesIpv4 ClusterCreateOptionsIpFamiliesEnum = "IPv4"
ClusterCreateOptionsIpFamiliesIpv6 ClusterCreateOptionsIpFamiliesEnum = "IPv6"
)
func GetClusterCreateOptionsIpFamiliesEnumValues() []ClusterCreateOptionsIpFamiliesEnum
GetClusterCreateOptionsIpFamiliesEnumValues Enumerates the set of values for ClusterCreateOptionsIpFamiliesEnum
func GetMappingClusterCreateOptionsIpFamiliesEnum(val string) (ClusterCreateOptionsIpFamiliesEnum, bool)
GetMappingClusterCreateOptionsIpFamiliesEnum performs case Insensitive comparison on enum value and return the desired enum
ClusterEndpointConfig The properties that define the network configuration for the Cluster endpoint.
type ClusterEndpointConfig struct {
// The OCID of the regional subnet in which to place the Cluster endpoint.
SubnetId *string `mandatory:"false" json:"subnetId"`
// A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail.
IsPublicIpEnabled *bool `mandatory:"false" json:"isPublicIpEnabled"`
}
func (m ClusterEndpointConfig) String() string
func (m ClusterEndpointConfig) 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
ClusterEndpoints The properties that define endpoints for a cluster.
type ClusterEndpoints struct {
// The non-native networking Kubernetes API server endpoint.
Kubernetes *string `mandatory:"false" json:"kubernetes"`
// The public native networking Kubernetes API server endpoint, if one was requested.
PublicEndpoint *string `mandatory:"false" json:"publicEndpoint"`
// The private native networking Kubernetes API server endpoint.
PrivateEndpoint *string `mandatory:"false" json:"privateEndpoint"`
// The FQDN assigned to the Kubernetes API private endpoint.
// Example: 'https://yourVcnHostnameEndpoint'
VcnHostnameEndpoint *string `mandatory:"false" json:"vcnHostnameEndpoint"`
// The IPv6 networking Kubernetes API server endpoint.
Ipv6Endpoint *string `mandatory:"false" json:"ipv6Endpoint"`
}
func (m ClusterEndpoints) String() string
func (m ClusterEndpoints) 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
ClusterLifecycleStateEnum Enum with underlying type: string
type ClusterLifecycleStateEnum string
Set of constants representing the allowable values for ClusterLifecycleStateEnum
const (
ClusterLifecycleStateCreating ClusterLifecycleStateEnum = "CREATING"
ClusterLifecycleStateActive ClusterLifecycleStateEnum = "ACTIVE"
ClusterLifecycleStateFailed ClusterLifecycleStateEnum = "FAILED"
ClusterLifecycleStateDeleting ClusterLifecycleStateEnum = "DELETING"
ClusterLifecycleStateDeleted ClusterLifecycleStateEnum = "DELETED"
ClusterLifecycleStateUpdating ClusterLifecycleStateEnum = "UPDATING"
)
Set of constants representing the allowable values for ClusterLifecycleStateEnum Deprecated
const (
ClusterSummaryLifecycleStateCreating ClusterLifecycleStateEnum = "CREATING"
ClusterSummaryLifecycleStateActive ClusterLifecycleStateEnum = "ACTIVE"
ClusterSummaryLifecycleStateFailed ClusterLifecycleStateEnum = "FAILED"
ClusterSummaryLifecycleStateDeleting ClusterLifecycleStateEnum = "DELETING"
ClusterSummaryLifecycleStateDeleted ClusterLifecycleStateEnum = "DELETED"
ClusterSummaryLifecycleStateUpdating ClusterLifecycleStateEnum = "UPDATING"
)
func GetClusterLifecycleStateEnumValues() []ClusterLifecycleStateEnum
GetClusterLifecycleStateEnumValues Enumerates the set of values for ClusterLifecycleStateEnum
func GetMappingClusterLifecycleStateEnum(val string) (ClusterLifecycleStateEnum, bool)
GetMappingClusterLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ClusterMetadata The properties that define meta data for a cluster.
type ClusterMetadata struct {
// The time the cluster was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The user who created the cluster.
CreatedByUserId *string `mandatory:"false" json:"createdByUserId"`
// The OCID of the work request which created the cluster.
CreatedByWorkRequestId *string `mandatory:"false" json:"createdByWorkRequestId"`
// The time the cluster was deleted.
TimeDeleted *common.SDKTime `mandatory:"false" json:"timeDeleted"`
// The user who deleted the cluster.
DeletedByUserId *string `mandatory:"false" json:"deletedByUserId"`
// The OCID of the work request which deleted the cluster.
DeletedByWorkRequestId *string `mandatory:"false" json:"deletedByWorkRequestId"`
// The time the cluster was updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The user who updated the cluster.
UpdatedByUserId *string `mandatory:"false" json:"updatedByUserId"`
// The OCID of the work request which updated the cluster.
UpdatedByWorkRequestId *string `mandatory:"false" json:"updatedByWorkRequestId"`
// The time until which the cluster credential is valid.
TimeCredentialExpiration *common.SDKTime `mandatory:"false" json:"timeCredentialExpiration"`
}
func (m ClusterMetadata) String() string
func (m ClusterMetadata) 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
ClusterMigrateToNativeVcnDetails The properties that define a request to migrate a cluster to Native VCN.
type ClusterMigrateToNativeVcnDetails struct {
// The network configuration for access to the Cluster control plane.
EndpointConfig *ClusterEndpointConfig `mandatory:"true" json:"endpointConfig"`
// The optional override of the non-native endpoint decommission time after migration is complete. Defaults to 30 days.
DecommissionDelayDuration *string `mandatory:"false" json:"decommissionDelayDuration"`
}
func (m ClusterMigrateToNativeVcnDetails) String() string
func (m ClusterMigrateToNativeVcnDetails) 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
ClusterMigrateToNativeVcnRequest wrapper for the ClusterMigrateToNativeVcn operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ClusterMigrateToNativeVcn.go.html to see an example of how to use ClusterMigrateToNativeVcnRequest.
type ClusterMigrateToNativeVcnRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The details for the cluster's migration to native VCN.
ClusterMigrateToNativeVcnDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ClusterMigrateToNativeVcnRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ClusterMigrateToNativeVcnRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ClusterMigrateToNativeVcnRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ClusterMigrateToNativeVcnRequest) String() string
func (request ClusterMigrateToNativeVcnRequest) 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
ClusterMigrateToNativeVcnResponse wrapper for the ClusterMigrateToNativeVcn operation
type ClusterMigrateToNativeVcnResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ClusterMigrateToNativeVcnResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ClusterMigrateToNativeVcnResponse) String() string
ClusterMigrateToNativeVcnStatus Information regarding a cluster's move to Native VCN.
type ClusterMigrateToNativeVcnStatus struct {
// The current migration status of the cluster.
State ClusterMigrateToNativeVcnStatusStateEnum `mandatory:"true" json:"state"`
// The date and time the non-native VCN is due to be decommissioned.
TimeDecommissionScheduled *common.SDKTime `mandatory:"false" json:"timeDecommissionScheduled"`
}
func (m ClusterMigrateToNativeVcnStatus) String() string
func (m ClusterMigrateToNativeVcnStatus) 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
ClusterMigrateToNativeVcnStatusStateEnum Enum with underlying type: string
type ClusterMigrateToNativeVcnStatusStateEnum string
Set of constants representing the allowable values for ClusterMigrateToNativeVcnStatusStateEnum
const (
ClusterMigrateToNativeVcnStatusStateNotStarted ClusterMigrateToNativeVcnStatusStateEnum = "NOT_STARTED"
ClusterMigrateToNativeVcnStatusStateRequested ClusterMigrateToNativeVcnStatusStateEnum = "REQUESTED"
ClusterMigrateToNativeVcnStatusStateInProgress ClusterMigrateToNativeVcnStatusStateEnum = "IN_PROGRESS"
ClusterMigrateToNativeVcnStatusStatePendingDecommission ClusterMigrateToNativeVcnStatusStateEnum = "PENDING_DECOMMISSION"
ClusterMigrateToNativeVcnStatusStateCompleted ClusterMigrateToNativeVcnStatusStateEnum = "COMPLETED"
)
func GetClusterMigrateToNativeVcnStatusStateEnumValues() []ClusterMigrateToNativeVcnStatusStateEnum
GetClusterMigrateToNativeVcnStatusStateEnumValues Enumerates the set of values for ClusterMigrateToNativeVcnStatusStateEnum
func GetMappingClusterMigrateToNativeVcnStatusStateEnum(val string) (ClusterMigrateToNativeVcnStatusStateEnum, bool)
GetMappingClusterMigrateToNativeVcnStatusStateEnum performs case Insensitive comparison on enum value and return the desired enum
ClusterOptions Options for creating or updating clusters.
type ClusterOptions struct {
// Available Kubernetes versions.
KubernetesVersions []string `mandatory:"false" json:"kubernetesVersions"`
// Available CNIs and network options for existing and new node pools of the cluster
ClusterPodNetworkOptions []ClusterPodNetworkOptionDetails `mandatory:"false" json:"clusterPodNetworkOptions"`
}
func (m ClusterOptions) String() string
func (m *ClusterOptions) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ClusterOptions) 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
ClusterPodNetworkOptionDetails The CNI type and relevant network details potentially applicable to the node pools of the cluster
type ClusterPodNetworkOptionDetails interface {
}
ClusterPodNetworkOptionDetailsCniTypeEnum Enum with underlying type: string
type ClusterPodNetworkOptionDetailsCniTypeEnum string
Set of constants representing the allowable values for ClusterPodNetworkOptionDetailsCniTypeEnum
const (
ClusterPodNetworkOptionDetailsCniTypeOciVcnIpNative ClusterPodNetworkOptionDetailsCniTypeEnum = "OCI_VCN_IP_NATIVE"
ClusterPodNetworkOptionDetailsCniTypeFlannelOverlay ClusterPodNetworkOptionDetailsCniTypeEnum = "FLANNEL_OVERLAY"
)
func GetClusterPodNetworkOptionDetailsCniTypeEnumValues() []ClusterPodNetworkOptionDetailsCniTypeEnum
GetClusterPodNetworkOptionDetailsCniTypeEnumValues Enumerates the set of values for ClusterPodNetworkOptionDetailsCniTypeEnum
func GetMappingClusterPodNetworkOptionDetailsCniTypeEnum(val string) (ClusterPodNetworkOptionDetailsCniTypeEnum, bool)
GetMappingClusterPodNetworkOptionDetailsCniTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ClusterSummary The properties that define a cluster summary.
type ClusterSummary struct {
// The OCID of the cluster.
Id *string `mandatory:"false" json:"id"`
// The name of the cluster.
Name *string `mandatory:"false" json:"name"`
// The OCID of the compartment in which the cluster exists.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The network configuration for access to the Cluster control plane.
EndpointConfig *ClusterEndpointConfig `mandatory:"false" json:"endpointConfig"`
// The OCID of the virtual cloud network (VCN) in which the cluster exists
VcnId *string `mandatory:"false" json:"vcnId"`
// The version of Kubernetes running on the cluster masters.
KubernetesVersion *string `mandatory:"false" json:"kubernetesVersion"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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"`
// Optional attributes for the cluster.
Options *ClusterCreateOptions `mandatory:"false" json:"options"`
// Metadata about the cluster.
Metadata *ClusterMetadata `mandatory:"false" json:"metadata"`
// The state of the cluster masters. For more information, see Monitoring Clusters (https://docs.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm)
LifecycleState ClusterLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Details about the state of the cluster masters.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Endpoints served up by the cluster masters.
Endpoints *ClusterEndpoints `mandatory:"false" json:"endpoints"`
// Available Kubernetes versions to which the clusters masters may be upgraded.
AvailableKubernetesUpgrades []string `mandatory:"false" json:"availableKubernetesUpgrades"`
// The image verification policy for signature validation.
ImagePolicyConfig *ImagePolicyConfig `mandatory:"false" json:"imagePolicyConfig"`
// Available CNIs and network options for existing and new node pools of the cluster
ClusterPodNetworkOptions []ClusterPodNetworkOptionDetails `mandatory:"false" json:"clusterPodNetworkOptions"`
// Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see Cluster Types (https://docs.oracle.com/iaas/Content/ContEng/Tasks/contengcomparingenhancedwithbasicclusters_topic.htm)
Type ClusterTypeEnum `mandatory:"false" json:"type,omitempty"`
}
func (m ClusterSummary) String() string
func (m *ClusterSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ClusterSummary) 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
ClusterSummaryLifecycleStateEnum is an alias to type: ClusterLifecycleStateEnum Consider using ClusterLifecycleStateEnum instead Deprecated
type ClusterSummaryLifecycleStateEnum = ClusterLifecycleStateEnum
ClusterTypeEnum Enum with underlying type: string
type ClusterTypeEnum string
Set of constants representing the allowable values for ClusterTypeEnum
const (
ClusterTypeBasicCluster ClusterTypeEnum = "BASIC_CLUSTER"
ClusterTypeEnhancedCluster ClusterTypeEnum = "ENHANCED_CLUSTER"
)
func GetClusterTypeEnumValues() []ClusterTypeEnum
GetClusterTypeEnumValues Enumerates the set of values for ClusterTypeEnum
func GetMappingClusterTypeEnum(val string) (ClusterTypeEnum, bool)
GetMappingClusterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CompleteCredentialRotationRequest wrapper for the CompleteCredentialRotation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/CompleteCredentialRotation.go.html to see an example of how to use CompleteCredentialRotationRequest.
type CompleteCredentialRotationRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// A token you supply to uniquely identify the request and provide idempotency if
// the request is retried. Idempotency tokens expire after 24 hours.
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"`
// 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CompleteCredentialRotationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CompleteCredentialRotationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CompleteCredentialRotationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CompleteCredentialRotationRequest) String() string
func (request CompleteCredentialRotationRequest) 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
CompleteCredentialRotationResponse wrapper for the CompleteCredentialRotation operation
type CompleteCredentialRotationResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CompleteCredentialRotationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CompleteCredentialRotationResponse) String() string
ContainerEngineClient a client for ContainerEngine
type ContainerEngineClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewContainerEngineClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ContainerEngineClient, err error)
NewContainerEngineClientWithConfigurationProvider Creates a new default ContainerEngine client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewContainerEngineClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ContainerEngineClient, err error)
NewContainerEngineClientWithOboToken Creates a new default ContainerEngine client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client ContainerEngineClient) ClusterMigrateToNativeVcn(ctx context.Context, request ClusterMigrateToNativeVcnRequest) (response ClusterMigrateToNativeVcnResponse, err error)
ClusterMigrateToNativeVcn Initiates cluster migration to use native VCN.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ClusterMigrateToNativeVcn.go.html to see an example of how to use ClusterMigrateToNativeVcn API. A default retry strategy applies to this operation ClusterMigrateToNativeVcn()
func (client ContainerEngineClient) CompleteCredentialRotation(ctx context.Context, request CompleteCredentialRotationRequest) (response CompleteCredentialRotationResponse, err error)
CompleteCredentialRotation Complete cluster credential rotation. Retire old credentials from kubernetes components.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/CompleteCredentialRotation.go.html to see an example of how to use CompleteCredentialRotation API. A default retry strategy applies to this operation CompleteCredentialRotation()
func (client *ContainerEngineClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ContainerEngineClient) CreateCluster(ctx context.Context, request CreateClusterRequest) (response CreateClusterResponse, err error)
CreateCluster Create a new cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/CreateCluster.go.html to see an example of how to use CreateCluster API. A default retry strategy applies to this operation CreateCluster()
func (client ContainerEngineClient) CreateKubeconfig(ctx context.Context, request CreateKubeconfigRequest) (response CreateKubeconfigResponse, err error)
CreateKubeconfig Create the Kubeconfig YAML for a cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/CreateKubeconfig.go.html to see an example of how to use CreateKubeconfig API. A default retry strategy applies to this operation CreateKubeconfig()
func (client ContainerEngineClient) CreateNodePool(ctx context.Context, request CreateNodePoolRequest) (response CreateNodePoolResponse, err error)
CreateNodePool Create a new node pool.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/CreateNodePool.go.html to see an example of how to use CreateNodePool API. A default retry strategy applies to this operation CreateNodePool()
func (client ContainerEngineClient) CreateVirtualNodePool(ctx context.Context, request CreateVirtualNodePoolRequest) (response CreateVirtualNodePoolResponse, err error)
CreateVirtualNodePool Create a new virtual node pool.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/CreateVirtualNodePool.go.html to see an example of how to use CreateVirtualNodePool API. A default retry strategy applies to this operation CreateVirtualNodePool()
func (client ContainerEngineClient) CreateWorkloadMapping(ctx context.Context, request CreateWorkloadMappingRequest) (response CreateWorkloadMappingResponse, err error)
CreateWorkloadMapping Create the specified workloadMapping for a cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/CreateWorkloadMapping.go.html to see an example of how to use CreateWorkloadMapping API. A default retry strategy applies to this operation CreateWorkloadMapping()
func (client ContainerEngineClient) DeleteCluster(ctx context.Context, request DeleteClusterRequest) (response DeleteClusterResponse, err error)
DeleteCluster Delete a cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DeleteCluster.go.html to see an example of how to use DeleteCluster API. A default retry strategy applies to this operation DeleteCluster()
func (client ContainerEngineClient) DeleteNode(ctx context.Context, request DeleteNodeRequest) (response DeleteNodeResponse, err error)
DeleteNode Delete node.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DeleteNode.go.html to see an example of how to use DeleteNode API. A default retry strategy applies to this operation DeleteNode()
func (client ContainerEngineClient) DeleteNodePool(ctx context.Context, request DeleteNodePoolRequest) (response DeleteNodePoolResponse, err error)
DeleteNodePool Delete a node pool.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DeleteNodePool.go.html to see an example of how to use DeleteNodePool API. A default retry strategy applies to this operation DeleteNodePool()
func (client ContainerEngineClient) DeleteVirtualNodePool(ctx context.Context, request DeleteVirtualNodePoolRequest) (response DeleteVirtualNodePoolResponse, err error)
DeleteVirtualNodePool Delete a virtual node pool.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DeleteVirtualNodePool.go.html to see an example of how to use DeleteVirtualNodePool API. A default retry strategy applies to this operation DeleteVirtualNodePool()
func (client ContainerEngineClient) DeleteWorkRequest(ctx context.Context, request DeleteWorkRequestRequest) (response DeleteWorkRequestResponse, err error)
DeleteWorkRequest Cancel a work request that has not started.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DeleteWorkRequest.go.html to see an example of how to use DeleteWorkRequest API. A default retry strategy applies to this operation DeleteWorkRequest()
func (client ContainerEngineClient) DeleteWorkloadMapping(ctx context.Context, request DeleteWorkloadMappingRequest) (response DeleteWorkloadMappingResponse, err error)
DeleteWorkloadMapping Delete workloadMapping for a provisioned cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DeleteWorkloadMapping.go.html to see an example of how to use DeleteWorkloadMapping API. A default retry strategy applies to this operation DeleteWorkloadMapping()
func (client ContainerEngineClient) DisableAddon(ctx context.Context, request DisableAddonRequest) (response DisableAddonResponse, err error)
DisableAddon Disable addon for a provisioned cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DisableAddon.go.html to see an example of how to use DisableAddon API. A default retry strategy applies to this operation DisableAddon()
func (client ContainerEngineClient) GetAddon(ctx context.Context, request GetAddonRequest) (response GetAddonResponse, err error)
GetAddon Get the specified addon for a cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetAddon.go.html to see an example of how to use GetAddon API. A default retry strategy applies to this operation GetAddon()
func (client ContainerEngineClient) GetCluster(ctx context.Context, request GetClusterRequest) (response GetClusterResponse, err error)
GetCluster Get the details of a cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetCluster.go.html to see an example of how to use GetCluster API. A default retry strategy applies to this operation GetCluster()
func (client ContainerEngineClient) GetClusterMigrateToNativeVcnStatus(ctx context.Context, request GetClusterMigrateToNativeVcnStatusRequest) (response GetClusterMigrateToNativeVcnStatusResponse, err error)
GetClusterMigrateToNativeVcnStatus Get details on a cluster's migration to native VCN.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetClusterMigrateToNativeVcnStatus.go.html to see an example of how to use GetClusterMigrateToNativeVcnStatus API. A default retry strategy applies to this operation GetClusterMigrateToNativeVcnStatus()
func (client ContainerEngineClient) GetClusterOptions(ctx context.Context, request GetClusterOptionsRequest) (response GetClusterOptionsResponse, err error)
GetClusterOptions Get options available for clusters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetClusterOptions.go.html to see an example of how to use GetClusterOptions API. A default retry strategy applies to this operation GetClusterOptions()
func (client ContainerEngineClient) GetCredentialRotationStatus(ctx context.Context, request GetCredentialRotationStatusRequest) (response GetCredentialRotationStatusResponse, err error)
GetCredentialRotationStatus Get cluster credential rotation status.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetCredentialRotationStatus.go.html to see an example of how to use GetCredentialRotationStatus API. A default retry strategy applies to this operation GetCredentialRotationStatus()
func (client ContainerEngineClient) GetNodePool(ctx context.Context, request GetNodePoolRequest) (response GetNodePoolResponse, err error)
GetNodePool Get the details of a node pool.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetNodePool.go.html to see an example of how to use GetNodePool API. A default retry strategy applies to this operation GetNodePool()
func (client ContainerEngineClient) GetNodePoolOptions(ctx context.Context, request GetNodePoolOptionsRequest) (response GetNodePoolOptionsResponse, err error)
GetNodePoolOptions Get options available for node pools.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetNodePoolOptions.go.html to see an example of how to use GetNodePoolOptions API. A default retry strategy applies to this operation GetNodePoolOptions()
func (client ContainerEngineClient) GetVirtualNode(ctx context.Context, request GetVirtualNodeRequest) (response GetVirtualNodeResponse, err error)
GetVirtualNode Get the details of a virtual node.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetVirtualNode.go.html to see an example of how to use GetVirtualNode API. A default retry strategy applies to this operation GetVirtualNode()
func (client ContainerEngineClient) GetVirtualNodePool(ctx context.Context, request GetVirtualNodePoolRequest) (response GetVirtualNodePoolResponse, err error)
GetVirtualNodePool Get the details of a virtual node pool.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetVirtualNodePool.go.html to see an example of how to use GetVirtualNodePool API. A default retry strategy applies to this operation GetVirtualNodePool()
func (client ContainerEngineClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Get the details of a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client ContainerEngineClient) GetWorkloadMapping(ctx context.Context, request GetWorkloadMappingRequest) (response GetWorkloadMappingResponse, err error)
GetWorkloadMapping Get the specified workloadMapping for a cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetWorkloadMapping.go.html to see an example of how to use GetWorkloadMapping API. A default retry strategy applies to this operation GetWorkloadMapping()
func (client ContainerEngineClient) InstallAddon(ctx context.Context, request InstallAddonRequest) (response InstallAddonResponse, err error)
InstallAddon Install the specified addon for a cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/InstallAddon.go.html to see an example of how to use InstallAddon API. A default retry strategy applies to this operation InstallAddon()
func (client ContainerEngineClient) ListAddonOptions(ctx context.Context, request ListAddonOptionsRequest) (response ListAddonOptionsResponse, err error)
ListAddonOptions Get list of supported addons for a specific kubernetes version.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListAddonOptions.go.html to see an example of how to use ListAddonOptions API. A default retry strategy applies to this operation ListAddonOptions()
func (client ContainerEngineClient) ListAddons(ctx context.Context, request ListAddonsRequest) (response ListAddonsResponse, err error)
ListAddons List addon for a provisioned cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListAddons.go.html to see an example of how to use ListAddons API. A default retry strategy applies to this operation ListAddons()
func (client ContainerEngineClient) ListClusters(ctx context.Context, request ListClustersRequest) (response ListClustersResponse, err error)
ListClusters List all the cluster objects in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListClusters.go.html to see an example of how to use ListClusters API. A default retry strategy applies to this operation ListClusters()
func (client ContainerEngineClient) ListNodePools(ctx context.Context, request ListNodePoolsRequest) (response ListNodePoolsResponse, err error)
ListNodePools List all the node pools in a compartment, and optionally filter by cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListNodePools.go.html to see an example of how to use ListNodePools API. A default retry strategy applies to this operation ListNodePools()
func (client ContainerEngineClient) ListPodShapes(ctx context.Context, request ListPodShapesRequest) (response ListPodShapesResponse, err error)
ListPodShapes List all the Pod Shapes in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListPodShapes.go.html to see an example of how to use ListPodShapes API. A default retry strategy applies to this operation ListPodShapes()
func (client ContainerEngineClient) ListVirtualNodePools(ctx context.Context, request ListVirtualNodePoolsRequest) (response ListVirtualNodePoolsResponse, err error)
ListVirtualNodePools List all the virtual node pools in a compartment, and optionally filter by cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListVirtualNodePools.go.html to see an example of how to use ListVirtualNodePools API. A default retry strategy applies to this operation ListVirtualNodePools()
func (client ContainerEngineClient) ListVirtualNodes(ctx context.Context, request ListVirtualNodesRequest) (response ListVirtualNodesResponse, err error)
ListVirtualNodes List virtual nodes in a virtual node pool.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListVirtualNodes.go.html to see an example of how to use ListVirtualNodes API. A default retry strategy applies to this operation ListVirtualNodes()
func (client ContainerEngineClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Get the errors of a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client ContainerEngineClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Get the logs of a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client ContainerEngineClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests List all work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client ContainerEngineClient) ListWorkloadMappings(ctx context.Context, request ListWorkloadMappingsRequest) (response ListWorkloadMappingsResponse, err error)
ListWorkloadMappings List workloadMappings for a provisioned cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListWorkloadMappings.go.html to see an example of how to use ListWorkloadMappings API. A default retry strategy applies to this operation ListWorkloadMappings()
func (client *ContainerEngineClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ContainerEngineClient) StartCredentialRotation(ctx context.Context, request StartCredentialRotationRequest) (response StartCredentialRotationResponse, err error)
StartCredentialRotation Start cluster credential rotation by adding new credentials, old credentials will still work after this operation.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/StartCredentialRotation.go.html to see an example of how to use StartCredentialRotation API. A default retry strategy applies to this operation StartCredentialRotation()
func (client ContainerEngineClient) UpdateAddon(ctx context.Context, request UpdateAddonRequest) (response UpdateAddonResponse, err error)
UpdateAddon Update addon details for a cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/UpdateAddon.go.html to see an example of how to use UpdateAddon API. A default retry strategy applies to this operation UpdateAddon()
func (client ContainerEngineClient) UpdateCluster(ctx context.Context, request UpdateClusterRequest) (response UpdateClusterResponse, err error)
UpdateCluster Update the details of a cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/UpdateCluster.go.html to see an example of how to use UpdateCluster API. A default retry strategy applies to this operation UpdateCluster()
func (client ContainerEngineClient) UpdateClusterEndpointConfig(ctx context.Context, request UpdateClusterEndpointConfigRequest) (response UpdateClusterEndpointConfigResponse, err error)
UpdateClusterEndpointConfig Update the details of the cluster endpoint configuration.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/UpdateClusterEndpointConfig.go.html to see an example of how to use UpdateClusterEndpointConfig API. A default retry strategy applies to this operation UpdateClusterEndpointConfig()
func (client ContainerEngineClient) UpdateNodePool(ctx context.Context, request UpdateNodePoolRequest) (response UpdateNodePoolResponse, err error)
UpdateNodePool Update the details of a node pool.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/UpdateNodePool.go.html to see an example of how to use UpdateNodePool API. A default retry strategy applies to this operation UpdateNodePool()
func (client ContainerEngineClient) UpdateVirtualNodePool(ctx context.Context, request UpdateVirtualNodePoolRequest) (response UpdateVirtualNodePoolResponse, err error)
UpdateVirtualNodePool Update the details of a virtual node pool.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/UpdateVirtualNodePool.go.html to see an example of how to use UpdateVirtualNodePool API. A default retry strategy applies to this operation UpdateVirtualNodePool()
func (client ContainerEngineClient) UpdateWorkloadMapping(ctx context.Context, request UpdateWorkloadMappingRequest) (response UpdateWorkloadMappingResponse, err error)
UpdateWorkloadMapping Update workloadMapping details for a cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/UpdateWorkloadMapping.go.html to see an example of how to use UpdateWorkloadMapping API. A default retry strategy applies to this operation UpdateWorkloadMapping()
CreateClusterDetails The properties that define a request to create a cluster.
type CreateClusterDetails struct {
// The name of the cluster. Avoid entering confidential information.
Name *string `mandatory:"true" json:"name"`
// The OCID of the compartment in which to create the cluster.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the virtual cloud network (VCN) in which to create the cluster.
VcnId *string `mandatory:"true" json:"vcnId"`
// The version of Kubernetes to install into the cluster masters.
KubernetesVersion *string `mandatory:"true" json:"kubernetesVersion"`
// The network configuration for access to the Cluster control plane.
EndpointConfig *CreateClusterEndpointConfigDetails `mandatory:"false" json:"endpointConfig"`
// The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
// When used, `kubernetesVersion` must be at least `v1.13.0`.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Optional attributes for the cluster.
Options *ClusterCreateOptions `mandatory:"false" json:"options"`
// The image verification policy for signature validation. Once a policy is created and enabled with
// one or more kms keys, the policy will ensure all images deployed has been signed with the key(s)
// attached to the policy.
ImagePolicyConfig *CreateImagePolicyConfigDetails `mandatory:"false" json:"imagePolicyConfig"`
// Available CNIs and network options for existing and new node pools of the cluster
ClusterPodNetworkOptions []ClusterPodNetworkOptionDetails `mandatory:"false" json:"clusterPodNetworkOptions"`
// Type of cluster
Type ClusterTypeEnum `mandatory:"false" json:"type,omitempty"`
}
func (m CreateClusterDetails) String() string
func (m *CreateClusterDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateClusterDetails) 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
CreateClusterEndpointConfigDetails The properties that define the network configuration for the Cluster endpoint.
type CreateClusterEndpointConfigDetails struct {
// The OCID of the regional subnet in which to place the Cluster endpoint.
SubnetId *string `mandatory:"false" json:"subnetId"`
// A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail.
IsPublicIpEnabled *bool `mandatory:"false" json:"isPublicIpEnabled"`
}
func (m CreateClusterEndpointConfigDetails) String() string
func (m CreateClusterEndpointConfigDetails) 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
CreateClusterKubeconfigContentDetails The properties that define a request to create a cluster kubeconfig.
type CreateClusterKubeconfigContentDetails struct {
// The version of the kubeconfig token. Supported value 2.0.0
TokenVersion *string `mandatory:"false" json:"tokenVersion"`
// Deprecated. This field is no longer used.
Expiration *int `mandatory:"false" json:"expiration"`
// The endpoint to target. A cluster may have multiple endpoints exposed but the kubeconfig can only target one at a time.
Endpoint CreateClusterKubeconfigContentDetailsEndpointEnum `mandatory:"false" json:"endpoint,omitempty"`
}
func (m CreateClusterKubeconfigContentDetails) String() string
func (m CreateClusterKubeconfigContentDetails) 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
CreateClusterKubeconfigContentDetailsEndpointEnum Enum with underlying type: string
type CreateClusterKubeconfigContentDetailsEndpointEnum string
Set of constants representing the allowable values for CreateClusterKubeconfigContentDetailsEndpointEnum
const (
CreateClusterKubeconfigContentDetailsEndpointLegacyKubernetes CreateClusterKubeconfigContentDetailsEndpointEnum = "LEGACY_KUBERNETES"
CreateClusterKubeconfigContentDetailsEndpointPublicEndpoint CreateClusterKubeconfigContentDetailsEndpointEnum = "PUBLIC_ENDPOINT"
CreateClusterKubeconfigContentDetailsEndpointPrivateEndpoint CreateClusterKubeconfigContentDetailsEndpointEnum = "PRIVATE_ENDPOINT"
CreateClusterKubeconfigContentDetailsEndpointVcnHostname CreateClusterKubeconfigContentDetailsEndpointEnum = "VCN_HOSTNAME"
)
func GetCreateClusterKubeconfigContentDetailsEndpointEnumValues() []CreateClusterKubeconfigContentDetailsEndpointEnum
GetCreateClusterKubeconfigContentDetailsEndpointEnumValues Enumerates the set of values for CreateClusterKubeconfigContentDetailsEndpointEnum
func GetMappingCreateClusterKubeconfigContentDetailsEndpointEnum(val string) (CreateClusterKubeconfigContentDetailsEndpointEnum, bool)
GetMappingCreateClusterKubeconfigContentDetailsEndpointEnum performs case Insensitive comparison on enum value and return the desired enum
CreateClusterRequest wrapper for the CreateCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/CreateCluster.go.html to see an example of how to use CreateClusterRequest.
type CreateClusterRequest struct {
// The details of the cluster to create.
CreateClusterDetails `contributesTo:"body"`
// A token you supply to uniquely identify the request and provide idempotency if
// the request is retried. Idempotency tokens expire after 24 hours.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateClusterRequest) String() string
func (request CreateClusterRequest) 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
CreateClusterResponse wrapper for the CreateCluster operation
type CreateClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateClusterResponse) String() string
CreateImagePolicyConfigDetails The properties that define a image verification policy.
type CreateImagePolicyConfigDetails struct {
// Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.
IsPolicyEnabled *bool `mandatory:"false" json:"isPolicyEnabled"`
// A list of KMS key details.
KeyDetails []KeyDetails `mandatory:"false" json:"keyDetails"`
}
func (m CreateImagePolicyConfigDetails) String() string
func (m CreateImagePolicyConfigDetails) 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
CreateKubeconfigRequest wrapper for the CreateKubeconfig operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/CreateKubeconfig.go.html to see an example of how to use CreateKubeconfigRequest.
type CreateKubeconfigRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// 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 details of the cluster kubeconfig to create.
CreateClusterKubeconfigContentDetails `contributesTo:"body"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateKubeconfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateKubeconfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateKubeconfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateKubeconfigRequest) String() string
func (request CreateKubeconfigRequest) 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
CreateKubeconfigResponse wrapper for the CreateKubeconfig operation
type CreateKubeconfigResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateKubeconfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateKubeconfigResponse) String() string
CreateNodePoolDetails The properties that define a request to create a node pool.
type CreateNodePoolDetails struct {
// The OCID of the compartment in which the node pool exists.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the cluster to which this node pool is attached.
ClusterId *string `mandatory:"true" json:"clusterId"`
// The name of the node pool. Avoid entering confidential information.
Name *string `mandatory:"true" json:"name"`
// The name of the node shape of the nodes in the node pool.
NodeShape *string `mandatory:"true" json:"nodeShape"`
// The version of Kubernetes to install on the nodes in the node pool.
KubernetesVersion *string `mandatory:"false" json:"kubernetesVersion"`
// A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.
NodeMetadata map[string]string `mandatory:"false" json:"nodeMetadata"`
// Deprecated. Use `nodeSourceDetails` instead.
// If you specify values for both, this value is ignored.
// The name of the image running on the nodes in the node pool.
NodeImageName *string `mandatory:"false" json:"nodeImageName"`
// Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source.
NodeSourceDetails NodeSourceDetails `mandatory:"false" json:"nodeSourceDetails"`
// Specify the configuration of the shape to launch nodes in the node pool.
NodeShapeConfig *CreateNodeShapeConfigDetails `mandatory:"false" json:"nodeShapeConfig"`
// A list of key/value pairs to add to nodes after they join the Kubernetes cluster.
InitialNodeLabels []KeyValue `mandatory:"false" json:"initialNodeLabels"`
// The SSH public key on each node in the node pool on launch.
SshPublicKey *string `mandatory:"false" json:"sshPublicKey"`
// Optional, default to 1. The number of nodes to create in each subnet specified in subnetIds property.
// When used, subnetIds is required. This property is deprecated, use nodeConfigDetails instead.
QuantityPerSubnet *int `mandatory:"false" json:"quantityPerSubnet"`
// The OCIDs of the subnets in which to place nodes for this node pool. When used, quantityPerSubnet
// can be provided. This property is deprecated, use nodeConfigDetails. Exactly one of the
// subnetIds or nodeConfigDetails properties must be specified.
SubnetIds []string `mandatory:"false" json:"subnetIds"`
// The configuration of nodes in the node pool. Exactly one of the
// subnetIds or nodeConfigDetails properties must be specified.
NodeConfigDetails *CreateNodePoolNodeConfigDetails `mandatory:"false" json:"nodeConfigDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
NodeEvictionNodePoolSettings *NodeEvictionNodePoolSettings `mandatory:"false" json:"nodeEvictionNodePoolSettings"`
NodePoolCyclingDetails *NodePoolCyclingDetails `mandatory:"false" json:"nodePoolCyclingDetails"`
}
func (m CreateNodePoolDetails) String() string
func (m *CreateNodePoolDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateNodePoolDetails) 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
CreateNodePoolNodeConfigDetails The size and placement configuration of nodes in the node pool.
type CreateNodePoolNodeConfigDetails struct {
// The number of nodes that should be in the node pool.
Size *int `mandatory:"true" json:"size"`
// The placement configurations for the node pool. Provide one placement
// configuration for each availability domain in which you intend to launch a node.
// To use the node pool with a regional subnet, provide a placement configuration for
// each availability domain, and include the regional subnet in each placement
// configuration.
PlacementConfigs []NodePoolPlacementConfigDetails `mandatory:"true" json:"placementConfigs"`
// The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID of the Key Management Service key assigned to the boot volume.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.
IsPvEncryptionInTransitEnabled *bool `mandatory:"false" json:"isPvEncryptionInTransitEnabled"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The CNI related configuration of pods in the node pool.
NodePoolPodNetworkOptionDetails NodePoolPodNetworkOptionDetails `mandatory:"false" json:"nodePoolPodNetworkOptionDetails"`
}
func (m CreateNodePoolNodeConfigDetails) String() string
func (m *CreateNodePoolNodeConfigDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateNodePoolNodeConfigDetails) 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
CreateNodePoolRequest wrapper for the CreateNodePool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/CreateNodePool.go.html to see an example of how to use CreateNodePoolRequest.
type CreateNodePoolRequest struct {
// The details of the node pool to create.
CreateNodePoolDetails `contributesTo:"body"`
// A token you supply to uniquely identify the request and provide idempotency if
// the request is retried. Idempotency tokens expire after 24 hours.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateNodePoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateNodePoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateNodePoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateNodePoolRequest) String() string
func (request CreateNodePoolRequest) 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
CreateNodePoolResponse wrapper for the CreateNodePool operation
type CreateNodePoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateNodePoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateNodePoolResponse) String() string
CreateNodeShapeConfigDetails The shape configuration of the nodes.
type CreateNodeShapeConfigDetails struct {
// The total number of OCPUs available to each node in the node pool.
// See here (https://docs.oracle.com/iaas/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details.
Ocpus *float32 `mandatory:"false" json:"ocpus"`
// The total amount of memory available to each node, in gigabytes.
MemoryInGBs *float32 `mandatory:"false" json:"memoryInGBs"`
}
func (m CreateNodeShapeConfigDetails) String() string
func (m CreateNodeShapeConfigDetails) 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
CreateVirtualNodePoolDetails The properties that define a request to create a virtual node pool.
type CreateVirtualNodePoolDetails struct {
// Compartment of the virtual node pool.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster.
ClusterId *string `mandatory:"true" json:"clusterId"`
// Display name of the virtual node pool. This is a non-unique value.
DisplayName *string `mandatory:"true" json:"displayName"`
// The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations
PlacementConfigurations []PlacementConfiguration `mandatory:"true" json:"placementConfigurations"`
// Initial labels that will be added to the Kubernetes Virtual Node object when it registers.
InitialVirtualNodeLabels []InitialVirtualNodeLabel `mandatory:"false" json:"initialVirtualNodeLabels"`
// A taint is a collection of <key, value, effect>. These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling.
Taints []Taint `mandatory:"false" json:"taints"`
// The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.
Size *int `mandatory:"false" json:"size"`
// List of network security group id's applied to the Virtual Node VNIC.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The pod configuration for pods run on virtual nodes of this virtual node pool.
PodConfiguration *PodConfiguration `mandatory:"false" json:"podConfiguration"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
VirtualNodeTags *VirtualNodeTags `mandatory:"false" json:"virtualNodeTags"`
}
func (m CreateVirtualNodePoolDetails) String() string
func (m CreateVirtualNodePoolDetails) 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
CreateVirtualNodePoolRequest wrapper for the CreateVirtualNodePool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/CreateVirtualNodePool.go.html to see an example of how to use CreateVirtualNodePoolRequest.
type CreateVirtualNodePoolRequest struct {
// The details of the virtual node pool to create.
CreateVirtualNodePoolDetails `contributesTo:"body"`
// A token you supply to uniquely identify the request and provide idempotency if
// the request is retried. Idempotency tokens expire after 24 hours.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateVirtualNodePoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateVirtualNodePoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateVirtualNodePoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateVirtualNodePoolRequest) String() string
func (request CreateVirtualNodePoolRequest) 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
CreateVirtualNodePoolResponse wrapper for the CreateVirtualNodePool operation
type CreateVirtualNodePoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateVirtualNodePoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateVirtualNodePoolResponse) String() string
CreateWorkloadMappingDetails The properties that define a workloadMapping
type CreateWorkloadMappingDetails struct {
// The namespace of the workloadMapping.
Namespace *string `mandatory:"true" json:"namespace"`
// The OCID of the mapped customer compartment.
MappedCompartmentId *string `mandatory:"true" json:"mappedCompartmentId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateWorkloadMappingDetails) String() string
func (m CreateWorkloadMappingDetails) 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
CreateWorkloadMappingRequest wrapper for the CreateWorkloadMapping operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/CreateWorkloadMapping.go.html to see an example of how to use CreateWorkloadMappingRequest.
type CreateWorkloadMappingRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The details of the workloadMapping to be create.
CreateWorkloadMappingDetails `contributesTo:"body"`
// A token you supply to uniquely identify the request and provide idempotency if
// the request is retried. Idempotency tokens expire after 24 hours.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateWorkloadMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateWorkloadMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateWorkloadMappingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateWorkloadMappingRequest) String() string
func (request CreateWorkloadMappingRequest) 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
CreateWorkloadMappingResponse wrapper for the CreateWorkloadMapping operation
type CreateWorkloadMappingResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkloadMapping instance
WorkloadMapping `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateWorkloadMappingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateWorkloadMappingResponse) String() string
CredentialRotationStatus Information regarding cluster's credential rotation.
type CredentialRotationStatus struct {
// Credential rotation status of a kubernetes cluster
// IN_PROGRESS: Issuing new credentials to kubernetes cluster control plane and worker nodes or retiring old credentials from kubernetes cluster control plane and worker nodes.
// WAITING: Waiting for customer to invoke the complete rotation action or the automcatic complete rotation action.
// COMPLETED: New credentials are functional on kuberentes cluster.
Status CredentialRotationStatusStatusEnum `mandatory:"true" json:"status"`
// Details of a kuberenetes cluster credential rotation status:
// ISSUING_NEW_CREDENTIALS: Credential rotation is in progress. Starting to issue new credentials to kubernetes cluster control plane and worker nodes.
// NEW_CREDENTIALS_ISSUED: New credentials are added. At this stage cluster has both old and new credentials and is awaiting old credentials retirement.
// RETIRING_OLD_CREDENTIALS: Retirement of old credentials is in progress. Starting to remove old credentials from kubernetes cluster control plane and worker nodes.
// COMPLETED: Credential rotation is complete. Old credentials are retired.
StatusDetails CredentialRotationStatusStatusDetailsEnum `mandatory:"true" json:"statusDetails"`
// The time by which retirement of old credentials should start.
TimeAutoCompletionScheduled *common.SDKTime `mandatory:"false" json:"timeAutoCompletionScheduled"`
}
func (m CredentialRotationStatus) String() string
func (m CredentialRotationStatus) 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
CredentialRotationStatusStatusDetailsEnum Enum with underlying type: string
type CredentialRotationStatusStatusDetailsEnum string
Set of constants representing the allowable values for CredentialRotationStatusStatusDetailsEnum
const (
CredentialRotationStatusStatusDetailsIssuingNewCredentials CredentialRotationStatusStatusDetailsEnum = "ISSUING_NEW_CREDENTIALS"
CredentialRotationStatusStatusDetailsNewCredentialsIssued CredentialRotationStatusStatusDetailsEnum = "NEW_CREDENTIALS_ISSUED"
CredentialRotationStatusStatusDetailsRetiringOldCredentials CredentialRotationStatusStatusDetailsEnum = "RETIRING_OLD_CREDENTIALS"
CredentialRotationStatusStatusDetailsCompleted CredentialRotationStatusStatusDetailsEnum = "COMPLETED"
)
func GetCredentialRotationStatusStatusDetailsEnumValues() []CredentialRotationStatusStatusDetailsEnum
GetCredentialRotationStatusStatusDetailsEnumValues Enumerates the set of values for CredentialRotationStatusStatusDetailsEnum
func GetMappingCredentialRotationStatusStatusDetailsEnum(val string) (CredentialRotationStatusStatusDetailsEnum, bool)
GetMappingCredentialRotationStatusStatusDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
CredentialRotationStatusStatusEnum Enum with underlying type: string
type CredentialRotationStatusStatusEnum string
Set of constants representing the allowable values for CredentialRotationStatusStatusEnum
const (
CredentialRotationStatusStatusInProgress CredentialRotationStatusStatusEnum = "IN_PROGRESS"
CredentialRotationStatusStatusWaiting CredentialRotationStatusStatusEnum = "WAITING"
CredentialRotationStatusStatusCompleted CredentialRotationStatusStatusEnum = "COMPLETED"
)
func GetCredentialRotationStatusStatusEnumValues() []CredentialRotationStatusStatusEnum
GetCredentialRotationStatusStatusEnumValues Enumerates the set of values for CredentialRotationStatusStatusEnum
func GetMappingCredentialRotationStatusStatusEnum(val string) (CredentialRotationStatusStatusEnum, bool)
GetMappingCredentialRotationStatusStatusEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteClusterRequest wrapper for the DeleteCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DeleteCluster.go.html to see an example of how to use DeleteClusterRequest.
type DeleteClusterRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteClusterRequest) String() string
func (request DeleteClusterRequest) 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
DeleteClusterResponse wrapper for the DeleteCluster operation
type DeleteClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteClusterResponse) String() string
DeleteNodePoolRequest wrapper for the DeleteNodePool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DeleteNodePool.go.html to see an example of how to use DeleteNodePoolRequest.
type DeleteNodePoolRequest struct {
// The OCID of the node pool.
NodePoolId *string `mandatory:"true" contributesTo:"path" name:"nodePoolId"`
// 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"`
// Duration after which OKE will give up eviction of the pods on the node.
// PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M
OverrideEvictionGraceDuration *string `mandatory:"false" contributesTo:"query" name:"overrideEvictionGraceDuration"`
// If the underlying compute instance should be deleted if you cannot evict all the pods in grace period
IsForceDeletionAfterOverrideGraceDuration *bool `mandatory:"false" contributesTo:"query" name:"isForceDeletionAfterOverrideGraceDuration"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteNodePoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteNodePoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteNodePoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteNodePoolRequest) String() string
func (request DeleteNodePoolRequest) 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
DeleteNodePoolResponse wrapper for the DeleteNodePool operation
type DeleteNodePoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteNodePoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteNodePoolResponse) String() string
DeleteNodeRequest wrapper for the DeleteNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DeleteNode.go.html to see an example of how to use DeleteNodeRequest.
type DeleteNodeRequest struct {
// The OCID of the node pool.
NodePoolId *string `mandatory:"true" contributesTo:"path" name:"nodePoolId"`
// The OCID of the compute instance.
NodeId *string `mandatory:"true" contributesTo:"path" name:"nodeId"`
// If the nodepool should be scaled down after the node is deleted.
IsDecrementSize *bool `mandatory:"false" contributesTo:"query" name:"isDecrementSize"`
// 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"`
// Duration after which OKE will give up eviction of the pods on the node.
// PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M
OverrideEvictionGraceDuration *string `mandatory:"false" contributesTo:"query" name:"overrideEvictionGraceDuration"`
// If the underlying compute instance should be deleted if you cannot evict all the pods in grace period
IsForceDeletionAfterOverrideGraceDuration *bool `mandatory:"false" contributesTo:"query" name:"isForceDeletionAfterOverrideGraceDuration"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteNodeRequest) String() string
func (request DeleteNodeRequest) 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
DeleteNodeResponse wrapper for the DeleteNode operation
type DeleteNodeResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteNodeResponse) String() string
DeleteVirtualNodePoolRequest wrapper for the DeleteVirtualNodePool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DeleteVirtualNodePool.go.html to see an example of how to use DeleteVirtualNodePoolRequest.
type DeleteVirtualNodePoolRequest struct {
// The OCID of the virtual node pool.
VirtualNodePoolId *string `mandatory:"true" contributesTo:"path" name:"virtualNodePoolId"`
// 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"`
// Duration after which SKE will give up eviction of the pods on the node.
// PT0M will indicate you want to delete the virtual node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M
OverrideEvictionGraceDurationVnp *string `mandatory:"false" contributesTo:"query" name:"overrideEvictionGraceDurationVnp"`
// If the underlying virtual node should be force deleted if all the pods are not evicted in the evictionGraceDuration.
IsForceDeletionAfterOverrideGraceDurationVnp *bool `mandatory:"false" contributesTo:"query" name:"isForceDeletionAfterOverrideGraceDurationVnp"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteVirtualNodePoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteVirtualNodePoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteVirtualNodePoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteVirtualNodePoolRequest) String() string
func (request DeleteVirtualNodePoolRequest) 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
DeleteVirtualNodePoolResponse wrapper for the DeleteVirtualNodePool operation
type DeleteVirtualNodePoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteVirtualNodePoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteVirtualNodePoolResponse) String() string
DeleteWorkRequestRequest wrapper for the DeleteWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DeleteWorkRequest.go.html to see an example of how to use DeleteWorkRequestRequest.
type DeleteWorkRequestRequest struct {
// The OCID of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteWorkRequestRequest) String() string
func (request DeleteWorkRequestRequest) 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
DeleteWorkRequestResponse wrapper for the DeleteWorkRequest operation
type DeleteWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteWorkRequestResponse) String() string
DeleteWorkloadMappingRequest wrapper for the DeleteWorkloadMapping operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DeleteWorkloadMapping.go.html to see an example of how to use DeleteWorkloadMappingRequest.
type DeleteWorkloadMappingRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The OCID of the workloadMapping.
WorkloadMappingId *string `mandatory:"true" contributesTo:"path" name:"workloadMappingId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteWorkloadMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteWorkloadMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteWorkloadMappingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteWorkloadMappingRequest) String() string
func (request DeleteWorkloadMappingRequest) 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
DeleteWorkloadMappingResponse wrapper for the DeleteWorkloadMapping operation
type DeleteWorkloadMappingResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteWorkloadMappingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteWorkloadMappingResponse) String() string
DisableAddonRequest wrapper for the DisableAddon operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/DisableAddon.go.html to see an example of how to use DisableAddonRequest.
type DisableAddonRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The name of the addon.
AddonName *string `mandatory:"true" contributesTo:"path" name:"addonName"`
// Whether existing addon resources should be deleted or not. True would remove the underlying resources completely.
IsRemoveExistingAddOn *bool `mandatory:"true" contributesTo:"query" name:"isRemoveExistingAddOn"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DisableAddonRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DisableAddonRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DisableAddonRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DisableAddonRequest) String() string
func (request DisableAddonRequest) 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
DisableAddonResponse wrapper for the DisableAddon operation
type DisableAddonResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DisableAddonResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DisableAddonResponse) String() string
FlannelOverlayClusterPodNetworkOptionDetails Network options specific to using the flannel (FLANNEL_OVERLAY) CNI
type FlannelOverlayClusterPodNetworkOptionDetails struct {
}
func (m FlannelOverlayClusterPodNetworkOptionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FlannelOverlayClusterPodNetworkOptionDetails) String() string
func (m FlannelOverlayClusterPodNetworkOptionDetails) 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
FlannelOverlayNodePoolPodNetworkOptionDetails Network options specific to using the flannel (FLANNEL_OVERLAY) CNI
type FlannelOverlayNodePoolPodNetworkOptionDetails struct {
}
func (m FlannelOverlayNodePoolPodNetworkOptionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FlannelOverlayNodePoolPodNetworkOptionDetails) String() string
func (m FlannelOverlayNodePoolPodNetworkOptionDetails) 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
GetAddonRequest wrapper for the GetAddon operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetAddon.go.html to see an example of how to use GetAddonRequest.
type GetAddonRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The name of the addon.
AddonName *string `mandatory:"true" contributesTo:"path" name:"addonName"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetAddonRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAddonRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAddonRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAddonRequest) String() string
func (request GetAddonRequest) 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
GetAddonResponse wrapper for the GetAddon operation
type GetAddonResponse struct {
// The underlying http response
RawResponse *http.Response
// The Addon instance
Addon `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetAddonResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAddonResponse) String() string
GetClusterMigrateToNativeVcnStatusRequest wrapper for the GetClusterMigrateToNativeVcnStatus operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetClusterMigrateToNativeVcnStatus.go.html to see an example of how to use GetClusterMigrateToNativeVcnStatusRequest.
type GetClusterMigrateToNativeVcnStatusRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetClusterMigrateToNativeVcnStatusRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetClusterMigrateToNativeVcnStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetClusterMigrateToNativeVcnStatusRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetClusterMigrateToNativeVcnStatusRequest) String() string
func (request GetClusterMigrateToNativeVcnStatusRequest) 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
GetClusterMigrateToNativeVcnStatusResponse wrapper for the GetClusterMigrateToNativeVcnStatus operation
type GetClusterMigrateToNativeVcnStatusResponse struct {
// The underlying http response
RawResponse *http.Response
// The ClusterMigrateToNativeVcnStatus instance
ClusterMigrateToNativeVcnStatus `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetClusterMigrateToNativeVcnStatusResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetClusterMigrateToNativeVcnStatusResponse) String() string
GetClusterOptionsRequest wrapper for the GetClusterOptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetClusterOptions.go.html to see an example of how to use GetClusterOptionsRequest.
type GetClusterOptionsRequest struct {
// The id of the option set to retrieve. Use "all" get all options, or use a cluster ID to get options specific to the provided cluster.
ClusterOptionId *string `mandatory:"true" contributesTo:"path" name:"clusterOptionId"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetClusterOptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetClusterOptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetClusterOptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetClusterOptionsRequest) String() string
func (request GetClusterOptionsRequest) 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
GetClusterOptionsResponse wrapper for the GetClusterOptions operation
type GetClusterOptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// The ClusterOptions instance
ClusterOptions `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetClusterOptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetClusterOptionsResponse) String() string
GetClusterRequest wrapper for the GetCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetCluster.go.html to see an example of how to use GetClusterRequest.
type GetClusterRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetClusterRequest) String() string
func (request GetClusterRequest) 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
GetClusterResponse wrapper for the GetCluster operation
type GetClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The Cluster instance
Cluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetClusterResponse) String() string
GetCredentialRotationStatusRequest wrapper for the GetCredentialRotationStatus operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetCredentialRotationStatus.go.html to see an example of how to use GetCredentialRotationStatusRequest.
type GetCredentialRotationStatusRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetCredentialRotationStatusRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCredentialRotationStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCredentialRotationStatusRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCredentialRotationStatusRequest) String() string
func (request GetCredentialRotationStatusRequest) 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
GetCredentialRotationStatusResponse wrapper for the GetCredentialRotationStatus operation
type GetCredentialRotationStatusResponse struct {
// The underlying http response
RawResponse *http.Response
// The CredentialRotationStatus instance
CredentialRotationStatus `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetCredentialRotationStatusResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCredentialRotationStatusResponse) String() string
GetNodePoolOptionsRequest wrapper for the GetNodePoolOptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetNodePoolOptions.go.html to see an example of how to use GetNodePoolOptionsRequest.
type GetNodePoolOptionsRequest struct {
// The id of the option set to retrieve. Use "all" get all options, or use a cluster ID to get options specific to the provided cluster.
NodePoolOptionId *string `mandatory:"true" contributesTo:"path" name:"nodePoolOptionId"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetNodePoolOptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetNodePoolOptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetNodePoolOptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetNodePoolOptionsRequest) String() string
func (request GetNodePoolOptionsRequest) 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
GetNodePoolOptionsResponse wrapper for the GetNodePoolOptions operation
type GetNodePoolOptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// The NodePoolOptions instance
NodePoolOptions `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetNodePoolOptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetNodePoolOptionsResponse) String() string
GetNodePoolRequest wrapper for the GetNodePool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetNodePool.go.html to see an example of how to use GetNodePoolRequest.
type GetNodePoolRequest struct {
// The OCID of the node pool.
NodePoolId *string `mandatory:"true" contributesTo:"path" name:"nodePoolId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetNodePoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetNodePoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetNodePoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetNodePoolRequest) String() string
func (request GetNodePoolRequest) 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
GetNodePoolResponse wrapper for the GetNodePool operation
type GetNodePoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The NodePool instance
NodePool `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetNodePoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetNodePoolResponse) String() string
GetVirtualNodePoolRequest wrapper for the GetVirtualNodePool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetVirtualNodePool.go.html to see an example of how to use GetVirtualNodePoolRequest.
type GetVirtualNodePoolRequest struct {
// The OCID of the virtual node pool.
VirtualNodePoolId *string `mandatory:"true" contributesTo:"path" name:"virtualNodePoolId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetVirtualNodePoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetVirtualNodePoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetVirtualNodePoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetVirtualNodePoolRequest) String() string
func (request GetVirtualNodePoolRequest) 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
GetVirtualNodePoolResponse wrapper for the GetVirtualNodePool operation
type GetVirtualNodePoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The VirtualNodePool instance
VirtualNodePool `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetVirtualNodePoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetVirtualNodePoolResponse) String() string
GetVirtualNodeRequest wrapper for the GetVirtualNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetVirtualNode.go.html to see an example of how to use GetVirtualNodeRequest.
type GetVirtualNodeRequest struct {
// The OCID of the virtual node pool.
VirtualNodePoolId *string `mandatory:"true" contributesTo:"path" name:"virtualNodePoolId"`
// The OCID of the virtual node.
VirtualNodeId *string `mandatory:"true" contributesTo:"path" name:"virtualNodeId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetVirtualNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetVirtualNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetVirtualNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetVirtualNodeRequest) String() string
func (request GetVirtualNodeRequest) 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
GetVirtualNodeResponse wrapper for the GetVirtualNode operation
type GetVirtualNodeResponse struct {
// The underlying http response
RawResponse *http.Response
// The VirtualNode instance
VirtualNode `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetVirtualNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetVirtualNodeResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// 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"`
// the number of seconds to should wait before polling this endpoint again
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
GetWorkloadMappingRequest wrapper for the GetWorkloadMapping operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/GetWorkloadMapping.go.html to see an example of how to use GetWorkloadMappingRequest.
type GetWorkloadMappingRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The OCID of the workloadMapping.
WorkloadMappingId *string `mandatory:"true" contributesTo:"path" name:"workloadMappingId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkloadMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkloadMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkloadMappingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkloadMappingRequest) String() string
func (request GetWorkloadMappingRequest) 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
GetWorkloadMappingResponse wrapper for the GetWorkloadMapping operation
type GetWorkloadMappingResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkloadMapping instance
WorkloadMapping `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetWorkloadMappingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkloadMappingResponse) String() string
ImagePolicyConfig The properties that define a image verification policy.
type ImagePolicyConfig struct {
// Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.
IsPolicyEnabled *bool `mandatory:"false" json:"isPolicyEnabled"`
// A list of KMS key details.
KeyDetails []KeyDetails `mandatory:"false" json:"keyDetails"`
}
func (m ImagePolicyConfig) String() string
func (m ImagePolicyConfig) 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
InitialVirtualNodeLabel The properties that define a key value pair.
type InitialVirtualNodeLabel struct {
// The key of the pair.
Key *string `mandatory:"false" json:"key"`
// The value of the pair.
Value *string `mandatory:"false" json:"value"`
}
func (m InitialVirtualNodeLabel) String() string
func (m InitialVirtualNodeLabel) 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
InstallAddonDetails The properties that define to install/enable addon on a cluster
type InstallAddonDetails struct {
// The name of the addon.
AddonName *string `mandatory:"true" json:"addonName"`
// The version of addon to be installed.
Version *string `mandatory:"false" json:"version"`
// Addon configuration details.
Configurations []AddonConfiguration `mandatory:"false" json:"configurations"`
// Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details.
IsOverrideExisting *bool `mandatory:"false" json:"isOverrideExisting"`
}
func (m InstallAddonDetails) String() string
func (m InstallAddonDetails) 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
InstallAddonRequest wrapper for the InstallAddon operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/InstallAddon.go.html to see an example of how to use InstallAddonRequest.
type InstallAddonRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The details of the addon to be installed.
InstallAddonDetails `contributesTo:"body"`
// A token you supply to uniquely identify the request and provide idempotency if
// the request is retried. Idempotency tokens expire after 24 hours.
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"`
// 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request InstallAddonRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request InstallAddonRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request InstallAddonRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request InstallAddonRequest) String() string
func (request InstallAddonRequest) 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
InstallAddonResponse wrapper for the InstallAddon operation
type InstallAddonResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response InstallAddonResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response InstallAddonResponse) String() string
KeyDetails The properties that define the kms keys used by OKE for Image Signature verification.
type KeyDetails struct {
// The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
}
func (m KeyDetails) String() string
func (m KeyDetails) 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
KeyValue The properties that define a key value pair.
type KeyValue struct {
// The key of the pair.
Key *string `mandatory:"false" json:"key"`
// The value of the pair.
Value *string `mandatory:"false" json:"value"`
}
func (m KeyValue) String() string
func (m KeyValue) 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
KubernetesNetworkConfig The properties that define the network configuration for Kubernetes.
type KubernetesNetworkConfig struct {
// The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16.
PodsCidr *string `mandatory:"false" json:"podsCidr"`
// The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16.
ServicesCidr *string `mandatory:"false" json:"servicesCidr"`
}
func (m KubernetesNetworkConfig) String() string
func (m KubernetesNetworkConfig) 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
KubernetesVersionsFilters The range of kubernetes versions an addon can be configured.
type KubernetesVersionsFilters struct {
// The earliest kubernetes version.
MinimalVersion *string `mandatory:"false" json:"minimalVersion"`
// The latest kubernetes version.
MaximumVersion *string `mandatory:"false" json:"maximumVersion"`
// The exact version of kubernetes that are compatible.
ExactKubernetesVersions []string `mandatory:"false" json:"exactKubernetesVersions"`
}
func (m KubernetesVersionsFilters) String() string
func (m KubernetesVersionsFilters) 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
ListAddonOptionsRequest wrapper for the ListAddonOptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListAddonOptions.go.html to see an example of how to use ListAddonOptionsRequest.
type ListAddonOptionsRequest struct {
// The kubernetes version to fetch the addons.
KubernetesVersion *string `mandatory:"true" contributesTo:"query" name:"kubernetesVersion"`
// The name of the addon.
AddonName *string `mandatory:"false" contributesTo:"query" name:"addonName"`
// 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 maximum number of results per page, or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum. For important details about how pagination works,
// see List Pagination (https://docs.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The optional order in which to sort the results.
SortOrder ListAddonOptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The optional field to sort the results by.
SortBy ListAddonOptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListAddonOptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAddonOptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAddonOptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAddonOptionsRequest) String() string
func (request ListAddonOptionsRequest) 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
ListAddonOptionsResponse wrapper for the ListAddonOptions operation
type ListAddonOptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []AddonOptionSummary instances
Items []AddonOptionSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListAddonOptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAddonOptionsResponse) String() string
ListAddonOptionsSortByEnum Enum with underlying type: string
type ListAddonOptionsSortByEnum string
Set of constants representing the allowable values for ListAddonOptionsSortByEnum
const (
ListAddonOptionsSortByName ListAddonOptionsSortByEnum = "NAME"
ListAddonOptionsSortByTimeCreated ListAddonOptionsSortByEnum = "TIME_CREATED"
)
func GetListAddonOptionsSortByEnumValues() []ListAddonOptionsSortByEnum
GetListAddonOptionsSortByEnumValues Enumerates the set of values for ListAddonOptionsSortByEnum
func GetMappingListAddonOptionsSortByEnum(val string) (ListAddonOptionsSortByEnum, bool)
GetMappingListAddonOptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAddonOptionsSortOrderEnum Enum with underlying type: string
type ListAddonOptionsSortOrderEnum string
Set of constants representing the allowable values for ListAddonOptionsSortOrderEnum
const (
ListAddonOptionsSortOrderAsc ListAddonOptionsSortOrderEnum = "ASC"
ListAddonOptionsSortOrderDesc ListAddonOptionsSortOrderEnum = "DESC"
)
func GetListAddonOptionsSortOrderEnumValues() []ListAddonOptionsSortOrderEnum
GetListAddonOptionsSortOrderEnumValues Enumerates the set of values for ListAddonOptionsSortOrderEnum
func GetMappingListAddonOptionsSortOrderEnum(val string) (ListAddonOptionsSortOrderEnum, bool)
GetMappingListAddonOptionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListAddonsRequest wrapper for the ListAddons operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListAddons.go.html to see an example of how to use ListAddonsRequest.
type ListAddonsRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// 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 maximum number of results per page, or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum. For important details about how pagination works,
// see List Pagination (https://docs.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The optional order in which to sort the results.
SortOrder ListAddonsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The optional field to sort the results by.
SortBy ListAddonsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListAddonsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAddonsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAddonsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAddonsRequest) String() string
func (request ListAddonsRequest) 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
ListAddonsResponse wrapper for the ListAddons operation
type ListAddonsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []AddonSummary instances
Items []AddonSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListAddonsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAddonsResponse) String() string
ListAddonsSortByEnum Enum with underlying type: string
type ListAddonsSortByEnum string
Set of constants representing the allowable values for ListAddonsSortByEnum
const (
ListAddonsSortByName ListAddonsSortByEnum = "NAME"
ListAddonsSortByTimeCreated ListAddonsSortByEnum = "TIME_CREATED"
)
func GetListAddonsSortByEnumValues() []ListAddonsSortByEnum
GetListAddonsSortByEnumValues Enumerates the set of values for ListAddonsSortByEnum
func GetMappingListAddonsSortByEnum(val string) (ListAddonsSortByEnum, bool)
GetMappingListAddonsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAddonsSortOrderEnum Enum with underlying type: string
type ListAddonsSortOrderEnum string
Set of constants representing the allowable values for ListAddonsSortOrderEnum
const (
ListAddonsSortOrderAsc ListAddonsSortOrderEnum = "ASC"
ListAddonsSortOrderDesc ListAddonsSortOrderEnum = "DESC"
)
func GetListAddonsSortOrderEnumValues() []ListAddonsSortOrderEnum
GetListAddonsSortOrderEnumValues Enumerates the set of values for ListAddonsSortOrderEnum
func GetMappingListAddonsSortOrderEnum(val string) (ListAddonsSortOrderEnum, bool)
GetMappingListAddonsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListClustersRequest wrapper for the ListClusters operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListClusters.go.html to see an example of how to use ListClustersRequest.
type ListClustersRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A cluster lifecycle state to filter on. Can have multiple parameters of this name. For more information, see Monitoring Clusters (https://docs.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm)
LifecycleState []ClusterLifecycleStateEnum `contributesTo:"query" name:"lifecycleState" omitEmpty:"true" collectionFormat:"multi"`
// The name to filter on.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum. For important details about how pagination works,
// see List Pagination (https://docs.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The optional order in which to sort the results.
SortOrder ListClustersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The optional field to sort the results by.
SortBy ListClustersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListClustersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListClustersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListClustersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListClustersRequest) String() string
func (request ListClustersRequest) 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
ListClustersResponse wrapper for the ListClusters operation
type ListClustersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ClusterSummary instances
Items []ClusterSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListClustersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListClustersResponse) String() string
ListClustersSortByEnum Enum with underlying type: string
type ListClustersSortByEnum string
Set of constants representing the allowable values for ListClustersSortByEnum
const (
ListClustersSortById ListClustersSortByEnum = "ID"
ListClustersSortByName ListClustersSortByEnum = "NAME"
ListClustersSortByTimeCreated ListClustersSortByEnum = "TIME_CREATED"
)
func GetListClustersSortByEnumValues() []ListClustersSortByEnum
GetListClustersSortByEnumValues Enumerates the set of values for ListClustersSortByEnum
func GetMappingListClustersSortByEnum(val string) (ListClustersSortByEnum, bool)
GetMappingListClustersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListClustersSortOrderEnum Enum with underlying type: string
type ListClustersSortOrderEnum string
Set of constants representing the allowable values for ListClustersSortOrderEnum
const (
ListClustersSortOrderAsc ListClustersSortOrderEnum = "ASC"
ListClustersSortOrderDesc ListClustersSortOrderEnum = "DESC"
)
func GetListClustersSortOrderEnumValues() []ListClustersSortOrderEnum
GetListClustersSortOrderEnumValues Enumerates the set of values for ListClustersSortOrderEnum
func GetMappingListClustersSortOrderEnum(val string) (ListClustersSortOrderEnum, bool)
GetMappingListClustersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListNodePoolsRequest wrapper for the ListNodePools operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListNodePools.go.html to see an example of how to use ListNodePoolsRequest.
type ListNodePoolsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID of the cluster.
ClusterId *string `mandatory:"false" contributesTo:"query" name:"clusterId"`
// The name to filter on.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum. For important details about how pagination works,
// see List Pagination (https://docs.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The optional order in which to sort the results.
SortOrder ListNodePoolsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The optional field to sort the results by.
SortBy ListNodePoolsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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"`
// A list of nodepool lifecycle states on which to filter on, matching any of the list items (OR logic). eg. ACTIVE, DELETING. For more information, see Monitoring Clusters (https://docs.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm)
LifecycleState []NodePoolLifecycleStateEnum `contributesTo:"query" name:"lifecycleState" omitEmpty:"true" collectionFormat:"multi"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListNodePoolsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListNodePoolsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListNodePoolsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListNodePoolsRequest) String() string
func (request ListNodePoolsRequest) 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
ListNodePoolsResponse wrapper for the ListNodePools operation
type ListNodePoolsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []NodePoolSummary instances
Items []NodePoolSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListNodePoolsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListNodePoolsResponse) String() string
ListNodePoolsSortByEnum Enum with underlying type: string
type ListNodePoolsSortByEnum string
Set of constants representing the allowable values for ListNodePoolsSortByEnum
const (
ListNodePoolsSortById ListNodePoolsSortByEnum = "ID"
ListNodePoolsSortByName ListNodePoolsSortByEnum = "NAME"
ListNodePoolsSortByTimeCreated ListNodePoolsSortByEnum = "TIME_CREATED"
)
func GetListNodePoolsSortByEnumValues() []ListNodePoolsSortByEnum
GetListNodePoolsSortByEnumValues Enumerates the set of values for ListNodePoolsSortByEnum
func GetMappingListNodePoolsSortByEnum(val string) (ListNodePoolsSortByEnum, bool)
GetMappingListNodePoolsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListNodePoolsSortOrderEnum Enum with underlying type: string
type ListNodePoolsSortOrderEnum string
Set of constants representing the allowable values for ListNodePoolsSortOrderEnum
const (
ListNodePoolsSortOrderAsc ListNodePoolsSortOrderEnum = "ASC"
ListNodePoolsSortOrderDesc ListNodePoolsSortOrderEnum = "DESC"
)
func GetListNodePoolsSortOrderEnumValues() []ListNodePoolsSortOrderEnum
GetListNodePoolsSortOrderEnumValues Enumerates the set of values for ListNodePoolsSortOrderEnum
func GetMappingListNodePoolsSortOrderEnum(val string) (ListNodePoolsSortOrderEnum, bool)
GetMappingListNodePoolsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPodShapesRequest wrapper for the ListPodShapes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListPodShapes.go.html to see an example of how to use ListPodShapesRequest.
type ListPodShapesRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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 availability domain of the pod shape.
AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`
// The name to filter on.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum. For important details about how pagination works,
// see List Pagination (https://docs.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The optional order in which to sort the results.
SortOrder ListPodShapesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The optional field to sort the results by.
SortBy ListPodShapesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListPodShapesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPodShapesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPodShapesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPodShapesRequest) String() string
func (request ListPodShapesRequest) 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
ListPodShapesResponse wrapper for the ListPodShapes operation
type ListPodShapesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []PodShapeSummary instances
Items []PodShapeSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListPodShapesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPodShapesResponse) String() string
ListPodShapesSortByEnum Enum with underlying type: string
type ListPodShapesSortByEnum string
Set of constants representing the allowable values for ListPodShapesSortByEnum
const (
ListPodShapesSortById ListPodShapesSortByEnum = "ID"
ListPodShapesSortByName ListPodShapesSortByEnum = "NAME"
ListPodShapesSortByTimeCreated ListPodShapesSortByEnum = "TIME_CREATED"
)
func GetListPodShapesSortByEnumValues() []ListPodShapesSortByEnum
GetListPodShapesSortByEnumValues Enumerates the set of values for ListPodShapesSortByEnum
func GetMappingListPodShapesSortByEnum(val string) (ListPodShapesSortByEnum, bool)
GetMappingListPodShapesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPodShapesSortOrderEnum Enum with underlying type: string
type ListPodShapesSortOrderEnum string
Set of constants representing the allowable values for ListPodShapesSortOrderEnum
const (
ListPodShapesSortOrderAsc ListPodShapesSortOrderEnum = "ASC"
ListPodShapesSortOrderDesc ListPodShapesSortOrderEnum = "DESC"
)
func GetListPodShapesSortOrderEnumValues() []ListPodShapesSortOrderEnum
GetListPodShapesSortOrderEnumValues Enumerates the set of values for ListPodShapesSortOrderEnum
func GetMappingListPodShapesSortOrderEnum(val string) (ListPodShapesSortOrderEnum, bool)
GetMappingListPodShapesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListVirtualNodePoolsRequest wrapper for the ListVirtualNodePools operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListVirtualNodePools.go.html to see an example of how to use ListVirtualNodePoolsRequest.
type ListVirtualNodePoolsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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 OCID of the cluster.
ClusterId *string `mandatory:"false" contributesTo:"query" name:"clusterId"`
// The name to filter on.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum. For important details about how pagination works,
// see List Pagination (https://docs.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The optional order in which to sort the results.
SortOrder ListVirtualNodePoolsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The optional field to sort the results by.
SortBy ListVirtualNodePoolsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A virtual node pool lifecycle state to filter on. Can have multiple parameters of this name.
LifecycleState []VirtualNodePoolLifecycleStateEnum `contributesTo:"query" name:"lifecycleState" omitEmpty:"true" collectionFormat:"multi"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListVirtualNodePoolsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListVirtualNodePoolsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListVirtualNodePoolsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVirtualNodePoolsRequest) String() string
func (request ListVirtualNodePoolsRequest) 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
ListVirtualNodePoolsResponse wrapper for the ListVirtualNodePools operation
type ListVirtualNodePoolsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []VirtualNodePoolSummary instances
Items []VirtualNodePoolSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListVirtualNodePoolsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListVirtualNodePoolsResponse) String() string
ListVirtualNodePoolsSortByEnum Enum with underlying type: string
type ListVirtualNodePoolsSortByEnum string
Set of constants representing the allowable values for ListVirtualNodePoolsSortByEnum
const (
ListVirtualNodePoolsSortById ListVirtualNodePoolsSortByEnum = "ID"
ListVirtualNodePoolsSortByName ListVirtualNodePoolsSortByEnum = "NAME"
ListVirtualNodePoolsSortByTimeCreated ListVirtualNodePoolsSortByEnum = "TIME_CREATED"
)
func GetListVirtualNodePoolsSortByEnumValues() []ListVirtualNodePoolsSortByEnum
GetListVirtualNodePoolsSortByEnumValues Enumerates the set of values for ListVirtualNodePoolsSortByEnum
func GetMappingListVirtualNodePoolsSortByEnum(val string) (ListVirtualNodePoolsSortByEnum, bool)
GetMappingListVirtualNodePoolsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListVirtualNodePoolsSortOrderEnum Enum with underlying type: string
type ListVirtualNodePoolsSortOrderEnum string
Set of constants representing the allowable values for ListVirtualNodePoolsSortOrderEnum
const (
ListVirtualNodePoolsSortOrderAsc ListVirtualNodePoolsSortOrderEnum = "ASC"
ListVirtualNodePoolsSortOrderDesc ListVirtualNodePoolsSortOrderEnum = "DESC"
)
func GetListVirtualNodePoolsSortOrderEnumValues() []ListVirtualNodePoolsSortOrderEnum
GetListVirtualNodePoolsSortOrderEnumValues Enumerates the set of values for ListVirtualNodePoolsSortOrderEnum
func GetMappingListVirtualNodePoolsSortOrderEnum(val string) (ListVirtualNodePoolsSortOrderEnum, bool)
GetMappingListVirtualNodePoolsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListVirtualNodesRequest wrapper for the ListVirtualNodes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListVirtualNodes.go.html to see an example of how to use ListVirtualNodesRequest.
type ListVirtualNodesRequest struct {
// The OCID of the virtual node pool.
VirtualNodePoolId *string `mandatory:"true" contributesTo:"path" name:"virtualNodePoolId"`
// 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 name to filter on.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum. For important details about how pagination works,
// see List Pagination (https://docs.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The optional order in which to sort the results.
SortOrder ListVirtualNodesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The optional field to sort the results by.
SortBy ListVirtualNodesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListVirtualNodesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListVirtualNodesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListVirtualNodesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVirtualNodesRequest) String() string
func (request ListVirtualNodesRequest) 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
ListVirtualNodesResponse wrapper for the ListVirtualNodes operation
type ListVirtualNodesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []VirtualNodeSummary instances
Items []VirtualNodeSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListVirtualNodesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListVirtualNodesResponse) String() string
ListVirtualNodesSortByEnum Enum with underlying type: string
type ListVirtualNodesSortByEnum string
Set of constants representing the allowable values for ListVirtualNodesSortByEnum
const (
ListVirtualNodesSortById ListVirtualNodesSortByEnum = "ID"
ListVirtualNodesSortByName ListVirtualNodesSortByEnum = "NAME"
ListVirtualNodesSortByTimeCreated ListVirtualNodesSortByEnum = "TIME_CREATED"
)
func GetListVirtualNodesSortByEnumValues() []ListVirtualNodesSortByEnum
GetListVirtualNodesSortByEnumValues Enumerates the set of values for ListVirtualNodesSortByEnum
func GetMappingListVirtualNodesSortByEnum(val string) (ListVirtualNodesSortByEnum, bool)
GetMappingListVirtualNodesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListVirtualNodesSortOrderEnum Enum with underlying type: string
type ListVirtualNodesSortOrderEnum string
Set of constants representing the allowable values for ListVirtualNodesSortOrderEnum
const (
ListVirtualNodesSortOrderAsc ListVirtualNodesSortOrderEnum = "ASC"
ListVirtualNodesSortOrderDesc ListVirtualNodesSortOrderEnum = "DESC"
)
func GetListVirtualNodesSortOrderEnumValues() []ListVirtualNodesSortOrderEnum
GetListVirtualNodesSortOrderEnumValues Enumerates the set of values for ListVirtualNodesSortOrderEnum
func GetMappingListVirtualNodesSortOrderEnum(val string) (ListVirtualNodesSortOrderEnum, bool)
GetMappingListVirtualNodesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// The []WorkRequestError instance
Items []WorkRequestError `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// The []WorkRequestLogEntry instance
Items []WorkRequestLogEntry `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID of the cluster.
ClusterId *string `mandatory:"false" contributesTo:"query" name:"clusterId"`
// The OCID of the resource associated with a work request
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// Type of the resource associated with a work request
ResourceType ListWorkRequestsResourceTypeEnum `mandatory:"false" contributesTo:"query" name:"resourceType" omitEmpty:"true"`
// A work request status to filter on. Can have multiple parameters of this name.
Status []string `contributesTo:"query" name:"status" collectionFormat:"multi"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum. For important details about how pagination works,
// see List Pagination (https://docs.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The optional order in which to sort the results.
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The optional field to sort the results by.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResourceTypeEnum Enum with underlying type: string
type ListWorkRequestsResourceTypeEnum string
Set of constants representing the allowable values for ListWorkRequestsResourceTypeEnum
const (
ListWorkRequestsResourceTypeCluster ListWorkRequestsResourceTypeEnum = "CLUSTER"
ListWorkRequestsResourceTypeNodepool ListWorkRequestsResourceTypeEnum = "NODEPOOL"
)
func GetListWorkRequestsResourceTypeEnumValues() []ListWorkRequestsResourceTypeEnum
GetListWorkRequestsResourceTypeEnumValues Enumerates the set of values for ListWorkRequestsResourceTypeEnum
func GetMappingListWorkRequestsResourceTypeEnum(val string) (ListWorkRequestsResourceTypeEnum, bool)
GetMappingListWorkRequestsResourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestSummary instances
Items []WorkRequestSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortById ListWorkRequestsSortByEnum = "ID"
ListWorkRequestsSortByOperationType ListWorkRequestsSortByEnum = "OPERATION_TYPE"
ListWorkRequestsSortByStatus ListWorkRequestsSortByEnum = "STATUS"
ListWorkRequestsSortByTimeAccepted ListWorkRequestsSortByEnum = "TIME_ACCEPTED"
ListWorkRequestsSortByTimeStarted ListWorkRequestsSortByEnum = "TIME_STARTED"
ListWorkRequestsSortByTimeFinished ListWorkRequestsSortByEnum = "TIME_FINISHED"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkloadMappingsRequest wrapper for the ListWorkloadMappings operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/ListWorkloadMappings.go.html to see an example of how to use ListWorkloadMappingsRequest.
type ListWorkloadMappingsRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// 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 maximum number of results per page, or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum. For important details about how pagination works,
// see List Pagination (https://docs.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The optional order in which to sort the results.
SortOrder ListWorkloadMappingsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The optional field to sort the results by.
SortBy ListWorkloadMappingsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkloadMappingsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkloadMappingsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkloadMappingsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkloadMappingsRequest) String() string
func (request ListWorkloadMappingsRequest) 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
ListWorkloadMappingsResponse wrapper for the ListWorkloadMappings operation
type ListWorkloadMappingsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkloadMappingSummary instances
Items []WorkloadMappingSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkloadMappingsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkloadMappingsResponse) String() string
ListWorkloadMappingsSortByEnum Enum with underlying type: string
type ListWorkloadMappingsSortByEnum string
Set of constants representing the allowable values for ListWorkloadMappingsSortByEnum
const (
ListWorkloadMappingsSortByNamespace ListWorkloadMappingsSortByEnum = "NAMESPACE"
ListWorkloadMappingsSortByTimecreated ListWorkloadMappingsSortByEnum = "TIMECREATED"
)
func GetListWorkloadMappingsSortByEnumValues() []ListWorkloadMappingsSortByEnum
GetListWorkloadMappingsSortByEnumValues Enumerates the set of values for ListWorkloadMappingsSortByEnum
func GetMappingListWorkloadMappingsSortByEnum(val string) (ListWorkloadMappingsSortByEnum, bool)
GetMappingListWorkloadMappingsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkloadMappingsSortOrderEnum Enum with underlying type: string
type ListWorkloadMappingsSortOrderEnum string
Set of constants representing the allowable values for ListWorkloadMappingsSortOrderEnum
const (
ListWorkloadMappingsSortOrderAsc ListWorkloadMappingsSortOrderEnum = "ASC"
ListWorkloadMappingsSortOrderDesc ListWorkloadMappingsSortOrderEnum = "DESC"
)
func GetListWorkloadMappingsSortOrderEnumValues() []ListWorkloadMappingsSortOrderEnum
GetListWorkloadMappingsSortOrderEnumValues Enumerates the set of values for ListWorkloadMappingsSortOrderEnum
func GetMappingListWorkloadMappingsSortOrderEnum(val string) (ListWorkloadMappingsSortOrderEnum, bool)
GetMappingListWorkloadMappingsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
Node The properties that define a node.
type Node struct {
// The OCID of the compute instance backing this node.
Id *string `mandatory:"false" json:"id"`
// The name of the node.
Name *string `mandatory:"false" json:"name"`
// The version of Kubernetes this node is running.
KubernetesVersion *string `mandatory:"false" json:"kubernetesVersion"`
// The name of the availability domain in which this node is placed.
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The OCID of the subnet in which this node is placed.
SubnetId *string `mandatory:"false" json:"subnetId"`
// The OCID of the node pool to which this node belongs.
NodePoolId *string `mandatory:"false" json:"nodePoolId"`
// The fault domain of this node.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// The private IP address of this node.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The public IP address of this node.
PublicIp *string `mandatory:"false" json:"publicIp"`
// An error that may be associated with the node.
NodeError *NodeError `mandatory:"false" json:"nodeError"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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 state of the node. For more information, see Monitoring Clusters (https://docs.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm)
LifecycleState NodeLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Details about the state of the node.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m Node) String() string
func (m Node) 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
NodeError The properties that define an upstream error while managing a node.
type NodeError struct {
// A short error code that defines the upstream error, meant for programmatic parsing. See API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// A human-readable error string of the upstream error.
Message *string `mandatory:"true" json:"message"`
// The status of the HTTP response encountered in the upstream error.
Status *string `mandatory:"false" json:"status"`
// Unique Oracle-assigned identifier for the upstream request. If you need to contact Oracle about a particular upstream request, please provide the request ID.
OpcRequestId *string `mandatory:"false" json:"opc-request-id"`
}
func (m NodeError) String() string
func (m NodeError) 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
NodeEvictionNodePoolSettings Node Eviction Details configuration
type NodeEvictionNodePoolSettings struct {
// Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain.
// Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M
EvictionGraceDuration *string `mandatory:"false" json:"evictionGraceDuration"`
// If the underlying compute instance should be deleted if you cannot evict all the pods in grace period
IsForceDeleteAfterGraceDuration *bool `mandatory:"false" json:"isForceDeleteAfterGraceDuration"`
}
func (m NodeEvictionNodePoolSettings) String() string
func (m NodeEvictionNodePoolSettings) 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
NodeLifecycleStateEnum Enum with underlying type: string
type NodeLifecycleStateEnum string
Set of constants representing the allowable values for NodeLifecycleStateEnum
const (
NodeLifecycleStateCreating NodeLifecycleStateEnum = "CREATING"
NodeLifecycleStateActive NodeLifecycleStateEnum = "ACTIVE"
NodeLifecycleStateUpdating NodeLifecycleStateEnum = "UPDATING"
NodeLifecycleStateDeleting NodeLifecycleStateEnum = "DELETING"
NodeLifecycleStateDeleted NodeLifecycleStateEnum = "DELETED"
NodeLifecycleStateFailing NodeLifecycleStateEnum = "FAILING"
NodeLifecycleStateInactive NodeLifecycleStateEnum = "INACTIVE"
)
func GetMappingNodeLifecycleStateEnum(val string) (NodeLifecycleStateEnum, bool)
GetMappingNodeLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodeLifecycleStateEnumValues() []NodeLifecycleStateEnum
GetNodeLifecycleStateEnumValues Enumerates the set of values for NodeLifecycleStateEnum
NodePool A pool of compute nodes attached to a cluster. Avoid entering confidential information.
type NodePool struct {
// The OCID of the node pool.
Id *string `mandatory:"false" json:"id"`
// The state of the nodepool. For more information, see Monitoring Clusters (https://docs.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm)
LifecycleState NodePoolLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Details about the state of the nodepool.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The OCID of the compartment in which the node pool exists.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The OCID of the cluster to which this node pool is attached.
ClusterId *string `mandatory:"false" json:"clusterId"`
// The name of the node pool.
Name *string `mandatory:"false" json:"name"`
// The version of Kubernetes running on the nodes in the node pool.
KubernetesVersion *string `mandatory:"false" json:"kubernetesVersion"`
// A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.
NodeMetadata map[string]string `mandatory:"false" json:"nodeMetadata"`
// Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool.
NodeImageId *string `mandatory:"false" json:"nodeImageId"`
// Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool.
NodeImageName *string `mandatory:"false" json:"nodeImageName"`
// The shape configuration of the nodes.
NodeShapeConfig *NodeShapeConfig `mandatory:"false" json:"nodeShapeConfig"`
// Deprecated. see `nodeSourceDetails`. Source running on the nodes in the node pool.
NodeSource NodeSourceOption `mandatory:"false" json:"nodeSource"`
// Source running on the nodes in the node pool.
NodeSourceDetails NodeSourceDetails `mandatory:"false" json:"nodeSourceDetails"`
// The name of the node shape of the nodes in the node pool.
NodeShape *string `mandatory:"false" json:"nodeShape"`
// A list of key/value pairs to add to nodes after they join the Kubernetes cluster.
InitialNodeLabels []KeyValue `mandatory:"false" json:"initialNodeLabels"`
// The SSH public key on each node in the node pool on launch.
SshPublicKey *string `mandatory:"false" json:"sshPublicKey"`
// The number of nodes in each subnet.
QuantityPerSubnet *int `mandatory:"false" json:"quantityPerSubnet"`
// The OCIDs of the subnets in which to place nodes for this node pool.
SubnetIds []string `mandatory:"false" json:"subnetIds"`
// The nodes in the node pool.
Nodes []Node `mandatory:"false" json:"nodes"`
// The configuration of nodes in the node pool.
NodeConfigDetails *NodePoolNodeConfigDetails `mandatory:"false" json:"nodeConfigDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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"`
NodeEvictionNodePoolSettings *NodeEvictionNodePoolSettings `mandatory:"false" json:"nodeEvictionNodePoolSettings"`
NodePoolCyclingDetails *NodePoolCyclingDetails `mandatory:"false" json:"nodePoolCyclingDetails"`
}
func (m NodePool) String() string
func (m *NodePool) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m NodePool) 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
NodePoolCyclingDetails Node Pool Cycling Details
type NodePoolCyclingDetails struct {
// Maximum active nodes that would be terminated from nodepool during the cycling nodepool process.
// OKE supports both integer and percentage input.
// Defaults to 0, Ranges from 0 to Nodepool size or 0% to 100%
MaximumUnavailable *string `mandatory:"false" json:"maximumUnavailable"`
// Maximum additional new compute instances that would be temporarily created and added to nodepool during the cycling nodepool process.
// OKE supports both integer and percentage input.
// Defaults to 1, Ranges from 0 to Nodepool size or 0% to 100%
MaximumSurge *string `mandatory:"false" json:"maximumSurge"`
// If nodes in the nodepool will be cycled to have new changes.
IsNodeCyclingEnabled *bool `mandatory:"false" json:"isNodeCyclingEnabled"`
}
func (m NodePoolCyclingDetails) String() string
func (m NodePoolCyclingDetails) 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
NodePoolLifecycleStateEnum Enum with underlying type: string
type NodePoolLifecycleStateEnum string
Set of constants representing the allowable values for NodePoolLifecycleStateEnum
const (
NodePoolLifecycleStateDeleted NodePoolLifecycleStateEnum = "DELETED"
NodePoolLifecycleStateCreating NodePoolLifecycleStateEnum = "CREATING"
NodePoolLifecycleStateActive NodePoolLifecycleStateEnum = "ACTIVE"
NodePoolLifecycleStateUpdating NodePoolLifecycleStateEnum = "UPDATING"
NodePoolLifecycleStateDeleting NodePoolLifecycleStateEnum = "DELETING"
NodePoolLifecycleStateFailed NodePoolLifecycleStateEnum = "FAILED"
NodePoolLifecycleStateInactive NodePoolLifecycleStateEnum = "INACTIVE"
NodePoolLifecycleStateNeedsAttention NodePoolLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetMappingNodePoolLifecycleStateEnum(val string) (NodePoolLifecycleStateEnum, bool)
GetMappingNodePoolLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodePoolLifecycleStateEnumValues() []NodePoolLifecycleStateEnum
GetNodePoolLifecycleStateEnumValues Enumerates the set of values for NodePoolLifecycleStateEnum
NodePoolNodeConfigDetails The size and placement configuration of nodes in the node pool.
type NodePoolNodeConfigDetails struct {
// The number of nodes in the node pool.
Size *int `mandatory:"false" json:"size"`
// The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID of the Key Management Service key assigned to the boot volume.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.
IsPvEncryptionInTransitEnabled *bool `mandatory:"false" json:"isPvEncryptionInTransitEnabled"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The placement configurations for the node pool. Provide one placement
// configuration for each availability domain in which you intend to launch a node.
// To use the node pool with a regional subnet, provide a placement configuration for
// each availability domain, and include the regional subnet in each placement
// configuration.
PlacementConfigs []NodePoolPlacementConfigDetails `mandatory:"false" json:"placementConfigs"`
// The CNI related configuration of pods in the node pool.
NodePoolPodNetworkOptionDetails NodePoolPodNetworkOptionDetails `mandatory:"false" json:"nodePoolPodNetworkOptionDetails"`
}
func (m NodePoolNodeConfigDetails) String() string
func (m *NodePoolNodeConfigDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m NodePoolNodeConfigDetails) 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
NodePoolOptions Options for creating or updating node pools.
type NodePoolOptions struct {
// Available Kubernetes versions.
KubernetesVersions []string `mandatory:"false" json:"kubernetesVersions"`
// Available shapes for nodes.
Shapes []string `mandatory:"false" json:"shapes"`
// Deprecated. See sources.
// When creating a node pool using the `CreateNodePoolDetails` object, only image names contained in this
// property can be passed to the `nodeImageName` property.
Images []string `mandatory:"false" json:"images"`
// Available source of the node.
Sources []NodeSourceOption `mandatory:"false" json:"sources"`
}
func (m NodePoolOptions) String() string
func (m *NodePoolOptions) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m NodePoolOptions) 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
NodePoolPlacementConfigDetails The location where a node pool will place nodes.
type NodePoolPlacementConfigDetails struct {
// The availability domain in which to place nodes.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The OCID of the subnet in which to place nodes.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The OCID of the compute capacity reservation in which to place the compute instance.
CapacityReservationId *string `mandatory:"false" json:"capacityReservationId"`
PreemptibleNodeConfig *PreemptibleNodeConfigDetails `mandatory:"false" json:"preemptibleNodeConfig"`
// A list of fault domains in which to place nodes.
FaultDomains []string `mandatory:"false" json:"faultDomains"`
}
func (m NodePoolPlacementConfigDetails) String() string
func (m NodePoolPlacementConfigDetails) 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
NodePoolPodNetworkOptionDetails The CNI type and relevant network details for the pods of a given node pool
type NodePoolPodNetworkOptionDetails interface {
}
NodePoolPodNetworkOptionDetailsCniTypeEnum Enum with underlying type: string
type NodePoolPodNetworkOptionDetailsCniTypeEnum string
Set of constants representing the allowable values for NodePoolPodNetworkOptionDetailsCniTypeEnum
const (
NodePoolPodNetworkOptionDetailsCniTypeOciVcnIpNative NodePoolPodNetworkOptionDetailsCniTypeEnum = "OCI_VCN_IP_NATIVE"
NodePoolPodNetworkOptionDetailsCniTypeFlannelOverlay NodePoolPodNetworkOptionDetailsCniTypeEnum = "FLANNEL_OVERLAY"
)
func GetMappingNodePoolPodNetworkOptionDetailsCniTypeEnum(val string) (NodePoolPodNetworkOptionDetailsCniTypeEnum, bool)
GetMappingNodePoolPodNetworkOptionDetailsCniTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodePoolPodNetworkOptionDetailsCniTypeEnumValues() []NodePoolPodNetworkOptionDetailsCniTypeEnum
GetNodePoolPodNetworkOptionDetailsCniTypeEnumValues Enumerates the set of values for NodePoolPodNetworkOptionDetailsCniTypeEnum
NodePoolSummary The properties that define a node pool summary.
type NodePoolSummary struct {
// The OCID of the node pool.
Id *string `mandatory:"false" json:"id"`
// The state of the nodepool. For more information, see Monitoring Clusters (https://docs.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm)
LifecycleState NodePoolLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Details about the state of the nodepool.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The OCID of the compartment in which the node pool exists.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The OCID of the cluster to which this node pool is attached.
ClusterId *string `mandatory:"false" json:"clusterId"`
// The name of the node pool.
Name *string `mandatory:"false" json:"name"`
// The version of Kubernetes running on the nodes in the node pool.
KubernetesVersion *string `mandatory:"false" json:"kubernetesVersion"`
// Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool.
NodeImageId *string `mandatory:"false" json:"nodeImageId"`
// Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool.
NodeImageName *string `mandatory:"false" json:"nodeImageName"`
// The shape configuration of the nodes.
NodeShapeConfig *NodeShapeConfig `mandatory:"false" json:"nodeShapeConfig"`
// Deprecated. see `nodeSourceDetails`. Source running on the nodes in the node pool.
NodeSource NodeSourceOption `mandatory:"false" json:"nodeSource"`
// Source running on the nodes in the node pool.
NodeSourceDetails NodeSourceDetails `mandatory:"false" json:"nodeSourceDetails"`
// The name of the node shape of the nodes in the node pool.
NodeShape *string `mandatory:"false" json:"nodeShape"`
// A list of key/value pairs to add to nodes after they join the Kubernetes cluster.
InitialNodeLabels []KeyValue `mandatory:"false" json:"initialNodeLabels"`
// The SSH public key on each node in the node pool on launch.
SshPublicKey *string `mandatory:"false" json:"sshPublicKey"`
// The number of nodes in each subnet.
QuantityPerSubnet *int `mandatory:"false" json:"quantityPerSubnet"`
// The OCIDs of the subnets in which to place nodes for this node pool.
SubnetIds []string `mandatory:"false" json:"subnetIds"`
// The configuration of nodes in the node pool.
NodeConfigDetails *NodePoolNodeConfigDetails `mandatory:"false" json:"nodeConfigDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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"`
NodeEvictionNodePoolSettings *NodeEvictionNodePoolSettings `mandatory:"false" json:"nodeEvictionNodePoolSettings"`
NodePoolCyclingDetails *NodePoolCyclingDetails `mandatory:"false" json:"nodePoolCyclingDetails"`
}
func (m NodePoolSummary) String() string
func (m *NodePoolSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m NodePoolSummary) 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
NodeShapeConfig The shape configuration of the nodes.
type NodeShapeConfig struct {
// The total number of OCPUs available to each node in the node pool.
// See here (https://docs.oracle.com/iaas/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details.
Ocpus *float32 `mandatory:"false" json:"ocpus"`
// The total amount of memory available to each node, in gigabytes.
MemoryInGBs *float32 `mandatory:"false" json:"memoryInGBs"`
}
func (m NodeShapeConfig) String() string
func (m NodeShapeConfig) 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
NodeSourceDetails The details of the node's source.
type NodeSourceDetails interface {
}
NodeSourceOption The source option for the node.
type NodeSourceOption interface {
// The user-friendly name of the entity corresponding to the OCID.
GetSourceName() *string
}
NodeSourceTypeEnum Enum with underlying type: string
type NodeSourceTypeEnum string
Set of constants representing the allowable values for NodeSourceTypeEnum
const (
NodeSourceTypeImage NodeSourceTypeEnum = "IMAGE"
)
func GetMappingNodeSourceTypeEnum(val string) (NodeSourceTypeEnum, bool)
GetMappingNodeSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodeSourceTypeEnumValues() []NodeSourceTypeEnum
GetNodeSourceTypeEnumValues Enumerates the set of values for NodeSourceTypeEnum
NodeSourceViaImageDetails Details of the image running on the node.
type NodeSourceViaImageDetails struct {
// The OCID of the image used to boot the node.
ImageId *string `mandatory:"true" json:"imageId"`
// The size of the boot volume in GBs. Minimum value is 50 GB. See here (https://docs.oracle.com/iaas/en-us/iaas/Content/Block/Concepts/bootvolumes.htm) for max custom boot volume sizing and OS-specific requirements.
BootVolumeSizeInGBs *int64 `mandatory:"false" json:"bootVolumeSizeInGBs"`
}
func (m NodeSourceViaImageDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NodeSourceViaImageDetails) String() string
func (m NodeSourceViaImageDetails) 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
NodeSourceViaImageOption An image can be specified as the source of nodes when launching a node pool using the `nodeSourceDetails` object.
type NodeSourceViaImageOption struct {
// The user-friendly name of the entity corresponding to the OCID.
SourceName *string `mandatory:"false" json:"sourceName"`
// The OCID of the image.
ImageId *string `mandatory:"false" json:"imageId"`
}
func (m NodeSourceViaImageOption) GetSourceName() *string
GetSourceName returns SourceName
func (m NodeSourceViaImageOption) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NodeSourceViaImageOption) String() string
func (m NodeSourceViaImageOption) 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
OciVcnIpNativeClusterPodNetworkOptionDetails Network options specific to using the OCI VCN Native CNI
type OciVcnIpNativeClusterPodNetworkOptionDetails struct {
}
func (m OciVcnIpNativeClusterPodNetworkOptionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciVcnIpNativeClusterPodNetworkOptionDetails) String() string
func (m OciVcnIpNativeClusterPodNetworkOptionDetails) 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
OciVcnIpNativeNodePoolPodNetworkOptionDetails Network options specific to using the OCI VCN Native CNI
type OciVcnIpNativeNodePoolPodNetworkOptionDetails struct {
// The OCIDs of the subnets in which to place pods for this node pool. This can be one of the node pool subnet IDs
PodSubnetIds []string `mandatory:"true" json:"podSubnetIds"`
// The max number of pods per node in the node pool. This value will be limited by the number of VNICs attachable to the node pool shape
MaxPodsPerNode *int `mandatory:"false" json:"maxPodsPerNode"`
// The OCIDs of the Network Security Group(s) to associate pods for this node pool with. For more information about NSGs, see NetworkSecurityGroup.
PodNsgIds []string `mandatory:"false" json:"podNsgIds"`
}
func (m OciVcnIpNativeNodePoolPodNetworkOptionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciVcnIpNativeNodePoolPodNetworkOptionDetails) String() string
func (m OciVcnIpNativeNodePoolPodNetworkOptionDetails) 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
OpenIdConnectDiscovery The property that define the status of the OIDC Discovery feature for a cluster.
type OpenIdConnectDiscovery struct {
// Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint.
IsOpenIdConnectDiscoveryEnabled *bool `mandatory:"false" json:"isOpenIdConnectDiscoveryEnabled"`
}
func (m OpenIdConnectDiscovery) String() string
func (m OpenIdConnectDiscovery) 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
OpenIdConnectTokenAuthenticationConfig The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server (https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-flags).
type OpenIdConnectTokenAuthenticationConfig struct {
// Whether the cluster has OIDC Auth Config enabled. Defaults to false.
IsOpenIdConnectAuthEnabled *bool `mandatory:"true" json:"isOpenIdConnectAuthEnabled"`
// URL of the provider that allows the API server to discover public signing keys.
// Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL,
// changed to have an empty path.
IssuerUrl *string `mandatory:"false" json:"issuerUrl"`
// A client id that all tokens must be issued for.
ClientId *string `mandatory:"false" json:"clientId"`
// JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end
// user. Admins can choose other claims, such as email or name, depending on their provider. However, claims
// other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins.
UsernameClaim *string `mandatory:"false" json:"usernameClaim"`
// Prefix prepended to username claims to prevent clashes with existing names (such as system:users).
// For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and
// --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where
// ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing.
UsernamePrefix *string `mandatory:"false" json:"usernamePrefix"`
// JWT claim to use as the user's group. If the claim is present it must be an array of strings.
GroupsClaim *string `mandatory:"false" json:"groupsClaim"`
// Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
GroupsPrefix *string `mandatory:"false" json:"groupsPrefix"`
// A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present
// in the ID Token with a matching value. Repeat this flag to specify multiple claims.
RequiredClaims []KeyValue `mandatory:"false" json:"requiredClaims"`
// A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
CaCertificate *string `mandatory:"false" json:"caCertificate"`
// The signing algorithms accepted. Default is ["RS256"].
SigningAlgorithms []string `mandatory:"false" json:"signingAlgorithms"`
// A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here (https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-authentication-configuration)
ConfigurationFile *string `mandatory:"false" json:"configurationFile"`
}
func (m OpenIdConnectTokenAuthenticationConfig) String() string
func (m OpenIdConnectTokenAuthenticationConfig) 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
PersistentVolumeConfigDetails Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
type PersistentVolumeConfigDetails struct {
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m PersistentVolumeConfigDetails) String() string
func (m PersistentVolumeConfigDetails) 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
PlacementConfiguration The information of virtual node placement in the virtual node pool.
type PlacementConfiguration struct {
// The availability domain in which to place virtual nodes.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The fault domain of this virtual node.
FaultDomain []string `mandatory:"false" json:"faultDomain"`
// The OCID of the subnet in which to place virtual nodes.
SubnetId *string `mandatory:"false" json:"subnetId"`
}
func (m PlacementConfiguration) String() string
func (m PlacementConfiguration) 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
PodConfiguration The pod configuration for pods run on virtual nodes of this virtual node pool.
type PodConfiguration struct {
// The regional subnet where pods' VNIC will be placed.
SubnetId *string `mandatory:"true" json:"subnetId"`
// Shape of the pods.
Shape *string `mandatory:"true" json:"shape"`
// List of network security group IDs applied to the Pod VNIC.
NsgIds []string `mandatory:"false" json:"nsgIds"`
}
func (m PodConfiguration) String() string
func (m PodConfiguration) 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
PodShape Pod shape.
type PodShape struct {
// The name of the identifying shape.
Name *string `mandatory:"true" json:"name"`
// A short description of the VM's processor (CPU).
ProcessorDescription *string `mandatory:"false" json:"processorDescription"`
// Options for OCPU shape.
OcpuOptions []ShapeOcpuOptions `mandatory:"false" json:"ocpuOptions"`
// ShapeMemoryOptions.
MemoryOptions []ShapeMemoryOptions `mandatory:"false" json:"memoryOptions"`
// ShapeNetworkBandwidthOptions.
NetworkBandwidthOptions []ShapeNetworkBandwidthOptions `mandatory:"false" json:"networkBandwidthOptions"`
}
func (m PodShape) String() string
func (m PodShape) 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
PodShapeSummary Pod shape.
type PodShapeSummary struct {
// The name of the identifying shape.
Name *string `mandatory:"true" json:"name"`
// A short description of the VM's processor (CPU).
ProcessorDescription *string `mandatory:"false" json:"processorDescription"`
// Options for OCPU shape.
OcpuOptions []ShapeOcpuOptions `mandatory:"false" json:"ocpuOptions"`
// ShapeMemoryOptions.
MemoryOptions []ShapeMemoryOptions `mandatory:"false" json:"memoryOptions"`
// ShapeNetworkBandwidthOptions.
NetworkBandwidthOptions []ShapeNetworkBandwidthOptions `mandatory:"false" json:"networkBandwidthOptions"`
}
func (m PodShapeSummary) String() string
func (m PodShapeSummary) 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
PreemptibleNodeConfigDetails Configuration options for preemptible nodes.
type PreemptibleNodeConfigDetails struct {
PreemptionAction PreemptionAction `mandatory:"true" json:"preemptionAction"`
}
func (m PreemptibleNodeConfigDetails) String() string
func (m *PreemptibleNodeConfigDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m PreemptibleNodeConfigDetails) 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
PreemptionAction The action to run when the preemptible node is interrupted for eviction.
type PreemptionAction interface {
}
PreemptionActionTypeEnum Enum with underlying type: string
type PreemptionActionTypeEnum string
Set of constants representing the allowable values for PreemptionActionTypeEnum
const (
PreemptionActionTypeTerminate PreemptionActionTypeEnum = "TERMINATE"
)
func GetMappingPreemptionActionTypeEnum(val string) (PreemptionActionTypeEnum, bool)
GetMappingPreemptionActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPreemptionActionTypeEnumValues() []PreemptionActionTypeEnum
GetPreemptionActionTypeEnumValues Enumerates the set of values for PreemptionActionTypeEnum
ServiceLbConfigDetails Configuration to be applied to load balancers created by Kubernetes services
type ServiceLbConfigDetails struct {
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m ServiceLbConfigDetails) String() string
func (m ServiceLbConfigDetails) 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
ShapeMemoryOptions Memory properties.
type ShapeMemoryOptions struct {
// The minimum amount of memory, in gigabytes.
MinInGBs *float32 `mandatory:"false" json:"minInGBs"`
// The maximum amount of memory, in gigabytes.
MaxInGBs *float32 `mandatory:"false" json:"maxInGBs"`
// The default amount of memory per OCPU available for this shape, in gigabytes.
DefaultPerOcpuInGBs *float32 `mandatory:"false" json:"defaultPerOcpuInGBs"`
// The minimum amount of memory per OCPU available for this shape, in gigabytes.
MinPerOcpuInGBs *float32 `mandatory:"false" json:"minPerOcpuInGBs"`
// The maximum amount of memory per OCPU available for this shape, in gigabytes.
MaxPerOcpuInGBs *float32 `mandatory:"false" json:"maxPerOcpuInGBs"`
}
func (m ShapeMemoryOptions) String() string
func (m ShapeMemoryOptions) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ShapeNetworkBandwidthOptions Properties of network bandwidth.
type ShapeNetworkBandwidthOptions struct {
// The minimum amount of networking bandwidth, in gigabits per second.
MinInGbps *float32 `mandatory:"false" json:"minInGbps"`
// The maximum amount of networking bandwidth, in gigabits per second.
MaxInGbps *float32 `mandatory:"false" json:"maxInGbps"`
// The default amount of networking bandwidth per OCPU, in gigabits per second.
DefaultPerOcpuInGbps *float32 `mandatory:"false" json:"defaultPerOcpuInGbps"`
}
func (m ShapeNetworkBandwidthOptions) String() string
func (m ShapeNetworkBandwidthOptions) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ShapeOcpuOptions Properties of OCPUs.
type ShapeOcpuOptions struct {
// The minimum number of OCPUs.
Min *float32 `mandatory:"false" json:"min"`
// The maximum number of OCPUs.
Max *float32 `mandatory:"false" json:"max"`
}
func (m ShapeOcpuOptions) String() string
func (m ShapeOcpuOptions) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
StartCredentialRotationDetails Properties that define a request to start credential rotation on a kubernetes cluster.
type StartCredentialRotationDetails struct {
// The duration in days(in ISO 8601 notation eg. P5D) after which the old credentials should be retired. Maximum delay duration is 90 days.
AutoCompletionDelayDuration *string `mandatory:"true" json:"autoCompletionDelayDuration"`
}
func (m StartCredentialRotationDetails) String() string
func (m StartCredentialRotationDetails) 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
StartCredentialRotationRequest wrapper for the StartCredentialRotation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/StartCredentialRotation.go.html to see an example of how to use StartCredentialRotationRequest.
type StartCredentialRotationRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The details for a kubernetes cluster to start credential rotation.
StartCredentialRotationDetails `contributesTo:"body"`
// A token you supply to uniquely identify the request and provide idempotency if
// the request is retried. Idempotency tokens expire after 24 hours.
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"`
// 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StartCredentialRotationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartCredentialRotationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartCredentialRotationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartCredentialRotationRequest) String() string
func (request StartCredentialRotationRequest) 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
StartCredentialRotationResponse wrapper for the StartCredentialRotation operation
type StartCredentialRotationResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response StartCredentialRotationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartCredentialRotationResponse) String() string
Taint taints
type Taint struct {
// The key of the pair.
Key *string `mandatory:"false" json:"key"`
// The value of the pair.
Value *string `mandatory:"false" json:"value"`
// The effect of the pair.
Effect *string `mandatory:"false" json:"effect"`
}
func (m Taint) String() string
func (m Taint) 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
TerminatePreemptionAction Terminates the preemptible instance when it is interrupted for eviction.
type TerminatePreemptionAction struct {
// Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
IsPreserveBootVolume *bool `mandatory:"false" json:"isPreserveBootVolume"`
}
func (m TerminatePreemptionAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TerminatePreemptionAction) String() string
func (m TerminatePreemptionAction) 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
UpdateAddonDetails The properties that define to update addon details.
type UpdateAddonDetails struct {
// The version of the installed addon.
Version *string `mandatory:"false" json:"version"`
// Addon configuration details.
Configurations []AddonConfiguration `mandatory:"false" json:"configurations"`
}
func (m UpdateAddonDetails) String() string
func (m UpdateAddonDetails) 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
UpdateAddonRequest wrapper for the UpdateAddon operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/UpdateAddon.go.html to see an example of how to use UpdateAddonRequest.
type UpdateAddonRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The name of the addon.
AddonName *string `mandatory:"true" contributesTo:"path" name:"addonName"`
// The details of the addon to be updated.
UpdateAddonDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateAddonRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAddonRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAddonRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAddonRequest) String() string
func (request UpdateAddonRequest) 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
UpdateAddonResponse wrapper for the UpdateAddon operation
type UpdateAddonResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateAddonResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAddonResponse) String() string
UpdateClusterDetails The properties that define a request to update a cluster.
type UpdateClusterDetails struct {
// The new name for the cluster. Avoid entering confidential information.
Name *string `mandatory:"false" json:"name"`
// The version of Kubernetes to which the cluster masters should be upgraded.
KubernetesVersion *string `mandatory:"false" json:"kubernetesVersion"`
Options *UpdateClusterOptionsDetails `mandatory:"false" json:"options"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The image verification policy for signature validation. Once a policy is created and enabled with
// one or more kms keys, the policy will ensure all images deployed has been signed with the key(s)
// attached to the policy.
ImagePolicyConfig *UpdateImagePolicyConfigDetails `mandatory:"false" json:"imagePolicyConfig"`
// Type of cluster
Type ClusterTypeEnum `mandatory:"false" json:"type,omitempty"`
}
func (m UpdateClusterDetails) String() string
func (m UpdateClusterDetails) 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
UpdateClusterEndpointConfigDetails The properties that define a request to update a cluster endpoint config.
type UpdateClusterEndpointConfigDetails struct {
// A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster update will fail.
IsPublicIpEnabled *bool `mandatory:"false" json:"isPublicIpEnabled"`
}
func (m UpdateClusterEndpointConfigDetails) String() string
func (m UpdateClusterEndpointConfigDetails) 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
UpdateClusterEndpointConfigRequest wrapper for the UpdateClusterEndpointConfig operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/UpdateClusterEndpointConfig.go.html to see an example of how to use UpdateClusterEndpointConfigRequest.
type UpdateClusterEndpointConfigRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The details of the cluster's endpoint to update.
UpdateClusterEndpointConfigDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateClusterEndpointConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateClusterEndpointConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateClusterEndpointConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateClusterEndpointConfigRequest) String() string
func (request UpdateClusterEndpointConfigRequest) 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
UpdateClusterEndpointConfigResponse wrapper for the UpdateClusterEndpointConfig operation
type UpdateClusterEndpointConfigResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateClusterEndpointConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateClusterEndpointConfigResponse) String() string
UpdateClusterOptionsDetails The properties that define extra options updating a cluster.
type UpdateClusterOptionsDetails struct {
// Configurable cluster admission controllers
AdmissionControllerOptions *AdmissionControllerOptions `mandatory:"false" json:"admissionControllerOptions"`
PersistentVolumeConfig *PersistentVolumeConfigDetails `mandatory:"false" json:"persistentVolumeConfig"`
ServiceLbConfig *ServiceLbConfigDetails `mandatory:"false" json:"serviceLbConfig"`
OpenIdConnectTokenAuthenticationConfig *OpenIdConnectTokenAuthenticationConfig `mandatory:"false" json:"openIdConnectTokenAuthenticationConfig"`
OpenIdConnectDiscovery *OpenIdConnectDiscovery `mandatory:"false" json:"openIdConnectDiscovery"`
}
func (m UpdateClusterOptionsDetails) String() string
func (m UpdateClusterOptionsDetails) 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
UpdateClusterRequest wrapper for the UpdateCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/UpdateCluster.go.html to see an example of how to use UpdateClusterRequest.
type UpdateClusterRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The details of the cluster to update.
UpdateClusterDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateClusterRequest) String() string
func (request UpdateClusterRequest) 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
UpdateClusterResponse wrapper for the UpdateCluster operation
type UpdateClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateClusterResponse) String() string
UpdateImagePolicyConfigDetails The properties that define a image verification policy.
type UpdateImagePolicyConfigDetails struct {
// Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.
IsPolicyEnabled *bool `mandatory:"false" json:"isPolicyEnabled"`
// A list of KMS key details.
KeyDetails []KeyDetails `mandatory:"false" json:"keyDetails"`
}
func (m UpdateImagePolicyConfigDetails) String() string
func (m UpdateImagePolicyConfigDetails) 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
UpdateNodePoolDetails The properties that define a request to update a node pool.
type UpdateNodePoolDetails struct {
// The new name for the cluster. Avoid entering confidential information.
Name *string `mandatory:"false" json:"name"`
// The version of Kubernetes to which the nodes in the node pool should be upgraded.
KubernetesVersion *string `mandatory:"false" json:"kubernetesVersion"`
// A list of key/value pairs to add to nodes after they join the Kubernetes cluster.
InitialNodeLabels []KeyValue `mandatory:"false" json:"initialNodeLabels"`
// The number of nodes to have in each subnet specified in the subnetIds property. This property is deprecated,
// use nodeConfigDetails instead. If the current value of quantityPerSubnet is greater than 0, you can only
// use quantityPerSubnet to scale the node pool. If the current value of quantityPerSubnet is equal to 0 and
// the current value of size in nodeConfigDetails is greater than 0, before you can use quantityPerSubnet,
// you must first scale the node pool to 0 nodes using nodeConfigDetails.
QuantityPerSubnet *int `mandatory:"false" json:"quantityPerSubnet"`
// The OCIDs of the subnets in which to place nodes for this node pool. This property is deprecated,
// use nodeConfigDetails instead. Only one of the subnetIds or nodeConfigDetails
// properties can be specified.
SubnetIds []string `mandatory:"false" json:"subnetIds"`
// The configuration of nodes in the node pool. Only one of the subnetIds or nodeConfigDetails
// properties should be specified. If the current value of quantityPerSubnet is greater than 0, the node
// pool may still be scaled using quantityPerSubnet. Before you can use nodeConfigDetails,
// you must first scale the node pool to 0 nodes using quantityPerSubnet.
NodeConfigDetails *UpdateNodePoolNodeConfigDetails `mandatory:"false" json:"nodeConfigDetails"`
// A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.
NodeMetadata map[string]string `mandatory:"false" json:"nodeMetadata"`
// Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source.
NodeSourceDetails NodeSourceDetails `mandatory:"false" json:"nodeSourceDetails"`
// The SSH public key to add to each node in the node pool on launch.
SshPublicKey *string `mandatory:"false" json:"sshPublicKey"`
// The name of the node shape of the nodes in the node pool used on launch.
NodeShape *string `mandatory:"false" json:"nodeShape"`
// Specify the configuration of the shape to launch nodes in the node pool.
NodeShapeConfig *UpdateNodeShapeConfigDetails `mandatory:"false" json:"nodeShapeConfig"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
NodeEvictionNodePoolSettings *NodeEvictionNodePoolSettings `mandatory:"false" json:"nodeEvictionNodePoolSettings"`
NodePoolCyclingDetails *NodePoolCyclingDetails `mandatory:"false" json:"nodePoolCyclingDetails"`
}
func (m UpdateNodePoolDetails) String() string
func (m *UpdateNodePoolDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateNodePoolDetails) 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
UpdateNodePoolNodeConfigDetails The size and placement configuration of nodes in the node pool.
type UpdateNodePoolNodeConfigDetails struct {
// The number of nodes in the node pool.
Size *int `mandatory:"false" json:"size"`
// The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID of the Key Management Service key assigned to the boot volume.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.
IsPvEncryptionInTransitEnabled *bool `mandatory:"false" json:"isPvEncryptionInTransitEnabled"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The placement configurations for the node pool. Provide one placement
// configuration for each availability domain in which you intend to launch a node.
// To use the node pool with a regional subnet, provide a placement configuration for
// each availability domain, and include the regional subnet in each placement
// configuration.
PlacementConfigs []NodePoolPlacementConfigDetails `mandatory:"false" json:"placementConfigs"`
// The CNI related configuration of pods in the node pool.
NodePoolPodNetworkOptionDetails NodePoolPodNetworkOptionDetails `mandatory:"false" json:"nodePoolPodNetworkOptionDetails"`
}
func (m UpdateNodePoolNodeConfigDetails) String() string
func (m *UpdateNodePoolNodeConfigDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateNodePoolNodeConfigDetails) 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
UpdateNodePoolRequest wrapper for the UpdateNodePool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/UpdateNodePool.go.html to see an example of how to use UpdateNodePoolRequest.
type UpdateNodePoolRequest struct {
// The OCID of the node pool.
NodePoolId *string `mandatory:"true" contributesTo:"path" name:"nodePoolId"`
// The fields to update in a node pool.
UpdateNodePoolDetails `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"`
// Duration after which OKE will give up eviction of the pods on the node.
// PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M
OverrideEvictionGraceDuration *string `mandatory:"false" contributesTo:"query" name:"overrideEvictionGraceDuration"`
// If the underlying compute instance should be deleted if you cannot evict all the pods in grace period
IsForceDeletionAfterOverrideGraceDuration *bool `mandatory:"false" contributesTo:"query" name:"isForceDeletionAfterOverrideGraceDuration"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateNodePoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateNodePoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateNodePoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateNodePoolRequest) String() string
func (request UpdateNodePoolRequest) 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
UpdateNodePoolResponse wrapper for the UpdateNodePool operation
type UpdateNodePoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateNodePoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateNodePoolResponse) String() string
UpdateNodeShapeConfigDetails The shape configuration of the nodes.
type UpdateNodeShapeConfigDetails struct {
// The total number of OCPUs available to each node in the node pool.
// See here (https://docs.oracle.com/iaas/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details.
Ocpus *float32 `mandatory:"false" json:"ocpus"`
// The total amount of memory available to each node, in gigabytes.
MemoryInGBs *float32 `mandatory:"false" json:"memoryInGBs"`
}
func (m UpdateNodeShapeConfigDetails) String() string
func (m UpdateNodeShapeConfigDetails) 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
UpdateVirtualNodePoolDetails The properties that define a request to update a virtual node pool.
type UpdateVirtualNodePoolDetails struct {
// Display name of the virtual node pool. This is a non-unique value.
DisplayName *string `mandatory:"false" json:"displayName"`
// Initial labels that will be added to the Kubernetes Virtual Node object when it registers.
InitialVirtualNodeLabels []InitialVirtualNodeLabel `mandatory:"false" json:"initialVirtualNodeLabels"`
// A taint is a collection of <key, value, effect>. These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling.
Taints []Taint `mandatory:"false" json:"taints"`
// The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.
Size *int `mandatory:"false" json:"size"`
// The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations
PlacementConfigurations []PlacementConfiguration `mandatory:"false" json:"placementConfigurations"`
// List of network security group id's applied to the Virtual Node VNIC.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The pod configuration for pods run on virtual nodes of this virtual node pool.
PodConfiguration *PodConfiguration `mandatory:"false" json:"podConfiguration"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
VirtualNodeTags *VirtualNodeTags `mandatory:"false" json:"virtualNodeTags"`
}
func (m UpdateVirtualNodePoolDetails) String() string
func (m UpdateVirtualNodePoolDetails) 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
UpdateVirtualNodePoolRequest wrapper for the UpdateVirtualNodePool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/UpdateVirtualNodePool.go.html to see an example of how to use UpdateVirtualNodePoolRequest.
type UpdateVirtualNodePoolRequest struct {
// The OCID of the virtual node pool.
VirtualNodePoolId *string `mandatory:"true" contributesTo:"path" name:"virtualNodePoolId"`
// The fields to update in a virtual node pool.
UpdateVirtualNodePoolDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateVirtualNodePoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateVirtualNodePoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateVirtualNodePoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateVirtualNodePoolRequest) String() string
func (request UpdateVirtualNodePoolRequest) 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
UpdateVirtualNodePoolResponse wrapper for the UpdateVirtualNodePool operation
type UpdateVirtualNodePoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request handling the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateVirtualNodePoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateVirtualNodePoolResponse) String() string
UpdateWorkloadMappingDetails The properties that define a workloadMapping
type UpdateWorkloadMappingDetails struct {
// The OCID of the mapped customer compartment.
MappedCompartmentId *string `mandatory:"false" json:"mappedCompartmentId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateWorkloadMappingDetails) String() string
func (m UpdateWorkloadMappingDetails) 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
UpdateWorkloadMappingRequest wrapper for the UpdateWorkloadMapping operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerengine/UpdateWorkloadMapping.go.html to see an example of how to use UpdateWorkloadMappingRequest.
type UpdateWorkloadMappingRequest struct {
// The OCID of the cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The OCID of the workloadMapping.
WorkloadMappingId *string `mandatory:"true" contributesTo:"path" name:"workloadMappingId"`
// The details of the workloadMapping to be updated.
UpdateWorkloadMappingDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateWorkloadMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateWorkloadMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateWorkloadMappingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateWorkloadMappingRequest) String() string
func (request UpdateWorkloadMappingRequest) 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
UpdateWorkloadMappingResponse wrapper for the UpdateWorkloadMapping operation
type UpdateWorkloadMappingResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkloadMapping instance
WorkloadMapping `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateWorkloadMappingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateWorkloadMappingResponse) String() string
VirtualNode The properties that define a virtual node.
type VirtualNode struct {
// The ocid of the virtual node.
Id *string `mandatory:"true" json:"id"`
// The name of the virtual node.
DisplayName *string `mandatory:"true" json:"displayName"`
// The ocid of the virtual node pool this virtual node belongs to.
VirtualNodePoolId *string `mandatory:"true" json:"virtualNodePoolId"`
// The version of Kubernetes this virtual node is running.
KubernetesVersion *string `mandatory:"false" json:"kubernetesVersion"`
// The name of the availability domain in which this virtual node is placed
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The fault domain of this virtual node.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// The OCID of the subnet in which this Virtual Node is placed.
SubnetId *string `mandatory:"false" json:"subnetId"`
// NSG Ids applied to virtual node vnic.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The private IP address of this Virtual Node.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// An error that may be associated with the virtual node.
VirtualNodeError *string `mandatory:"false" json:"virtualNodeError"`
// The state of the Virtual Node.
LifecycleState VirtualNodeLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Details about the state of the Virtual Node.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The time at which the virtual node was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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"`
}
func (m VirtualNode) String() string
func (m VirtualNode) 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
VirtualNodeLifecycleStateEnum Enum with underlying type: string
type VirtualNodeLifecycleStateEnum string
Set of constants representing the allowable values for VirtualNodeLifecycleStateEnum
const (
VirtualNodeLifecycleStateCreating VirtualNodeLifecycleStateEnum = "CREATING"
VirtualNodeLifecycleStateActive VirtualNodeLifecycleStateEnum = "ACTIVE"
VirtualNodeLifecycleStateUpdating VirtualNodeLifecycleStateEnum = "UPDATING"
VirtualNodeLifecycleStateDeleting VirtualNodeLifecycleStateEnum = "DELETING"
VirtualNodeLifecycleStateDeleted VirtualNodeLifecycleStateEnum = "DELETED"
VirtualNodeLifecycleStateFailed VirtualNodeLifecycleStateEnum = "FAILED"
VirtualNodeLifecycleStateNeedsAttention VirtualNodeLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetMappingVirtualNodeLifecycleStateEnum(val string) (VirtualNodeLifecycleStateEnum, bool)
GetMappingVirtualNodeLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualNodeLifecycleStateEnumValues() []VirtualNodeLifecycleStateEnum
GetVirtualNodeLifecycleStateEnumValues Enumerates the set of values for VirtualNodeLifecycleStateEnum
VirtualNodePool A pool of virtual nodes attached to a cluster.
type VirtualNodePool struct {
// The OCID of the virtual node pool.
Id *string `mandatory:"true" json:"id"`
// Compartment of the virtual node pool.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster.
ClusterId *string `mandatory:"true" json:"clusterId"`
// Display name of the virtual node pool. This is a non-unique value.
DisplayName *string `mandatory:"true" json:"displayName"`
// The version of Kubernetes running on the nodes in the node pool.
KubernetesVersion *string `mandatory:"true" json:"kubernetesVersion"`
// The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations
PlacementConfigurations []PlacementConfiguration `mandatory:"true" json:"placementConfigurations"`
// Initial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources.
InitialVirtualNodeLabels []InitialVirtualNodeLabel `mandatory:"false" json:"initialVirtualNodeLabels"`
// A taint is a collection of <key, value, effect>. These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling.
Taints []Taint `mandatory:"false" json:"taints"`
// The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.
Size *int `mandatory:"false" json:"size"`
// List of network security group id's applied to the Virtual Node VNIC.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The pod configuration for pods run on virtual nodes of this virtual node pool.
PodConfiguration *PodConfiguration `mandatory:"false" json:"podConfiguration"`
// The state of the Virtual Node Pool.
LifecycleState VirtualNodePoolLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Details about the state of the Virtual Node Pool.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The time the virtual node pool was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the virtual node pool was updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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"`
VirtualNodeTags *VirtualNodeTags `mandatory:"false" json:"virtualNodeTags"`
}
func (m VirtualNodePool) String() string
func (m VirtualNodePool) 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
VirtualNodePoolLifecycleStateEnum Enum with underlying type: string
type VirtualNodePoolLifecycleStateEnum string
Set of constants representing the allowable values for VirtualNodePoolLifecycleStateEnum
const (
VirtualNodePoolLifecycleStateCreating VirtualNodePoolLifecycleStateEnum = "CREATING"
VirtualNodePoolLifecycleStateActive VirtualNodePoolLifecycleStateEnum = "ACTIVE"
VirtualNodePoolLifecycleStateUpdating VirtualNodePoolLifecycleStateEnum = "UPDATING"
VirtualNodePoolLifecycleStateDeleting VirtualNodePoolLifecycleStateEnum = "DELETING"
VirtualNodePoolLifecycleStateDeleted VirtualNodePoolLifecycleStateEnum = "DELETED"
VirtualNodePoolLifecycleStateFailed VirtualNodePoolLifecycleStateEnum = "FAILED"
VirtualNodePoolLifecycleStateNeedsAttention VirtualNodePoolLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetMappingVirtualNodePoolLifecycleStateEnum(val string) (VirtualNodePoolLifecycleStateEnum, bool)
GetMappingVirtualNodePoolLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualNodePoolLifecycleStateEnumValues() []VirtualNodePoolLifecycleStateEnum
GetVirtualNodePoolLifecycleStateEnumValues Enumerates the set of values for VirtualNodePoolLifecycleStateEnum
VirtualNodePoolSummary The properties that define a virtual node pool summary.
type VirtualNodePoolSummary struct {
// The OCID of the virtual node pool.
Id *string `mandatory:"true" json:"id"`
// Compartment of the virtual node pool.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster.
ClusterId *string `mandatory:"true" json:"clusterId"`
// Display name of the virtual node pool. This is a non-unique value.
DisplayName *string `mandatory:"true" json:"displayName"`
// The version of Kubernetes running on the nodes in the node pool.
KubernetesVersion *string `mandatory:"true" json:"kubernetesVersion"`
// The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations
PlacementConfigurations []PlacementConfiguration `mandatory:"true" json:"placementConfigurations"`
// Initial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources.
InitialVirtualNodeLabels []InitialVirtualNodeLabel `mandatory:"false" json:"initialVirtualNodeLabels"`
// A taint is a collection of <key, value, effect>. These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling.
Taints []Taint `mandatory:"false" json:"taints"`
// The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.
Size *int `mandatory:"false" json:"size"`
// List of network security group id's applied to the Virtual Node VNIC.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The pod configuration for pods run on virtual nodes of this virtual node pool.
PodConfiguration *PodConfiguration `mandatory:"false" json:"podConfiguration"`
// The state of the Virtual Node Pool.
LifecycleState VirtualNodePoolLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Details about the state of the Virtual Node Pool.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The time the virtual node pool was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the virtual node pool was updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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"`
VirtualNodeTags *VirtualNodeTags `mandatory:"false" json:"virtualNodeTags"`
}
func (m VirtualNodePoolSummary) String() string
func (m VirtualNodePoolSummary) 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
VirtualNodeSummary The properties that define a virtual node summary.
type VirtualNodeSummary struct {
// The ocid of the virtual node.
Id *string `mandatory:"true" json:"id"`
// The name of the virtual node.
DisplayName *string `mandatory:"true" json:"displayName"`
// The ocid of the virtual node pool this virtual node belongs to.
VirtualNodePoolId *string `mandatory:"true" json:"virtualNodePoolId"`
// The version of Kubernetes this virtual node is running.
KubernetesVersion *string `mandatory:"false" json:"kubernetesVersion"`
// The name of the availability domain in which this virtual node is placed
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The fault domain of this virtual node.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// The OCID of the subnet in which this Virtual Node is placed.
SubnetId *string `mandatory:"false" json:"subnetId"`
// NSG Ids applied to virtual node vnic.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The private IP address of this Virtual Node.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// An error that may be associated with the virtual node.
VirtualNodeError *string `mandatory:"false" json:"virtualNodeError"`
// The state of the Virtual Node.
LifecycleState VirtualNodeLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Details about the state of the Virtual Node.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The time at which the virtual node was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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"`
}
func (m VirtualNodeSummary) String() string
func (m VirtualNodeSummary) 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
VirtualNodeTags The tags associated to the virtual nodes in this virtual node pool.
type VirtualNodeTags struct {
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m VirtualNodeTags) String() string
func (m VirtualNodeTags) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequest An asynchronous work request.
type WorkRequest struct {
// The OCID of the work request.
Id *string `mandatory:"false" json:"id"`
// The type of work the work request is doing.
OperationType WorkRequestOperationTypeEnum `mandatory:"false" json:"operationType,omitempty"`
// The current status of the work request.
Status WorkRequestStatusEnum `mandatory:"false" json:"status,omitempty"`
// The OCID of the compartment in which the work request exists.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The resources this work request affects.
Resources []WorkRequestResource `mandatory:"false" json:"resources"`
// The time the work request was accepted.
TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`
// The time the work request was started.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The time the work request was finished.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError Errors related to a specific work request.
type WorkRequestError struct {
// A short error code that defines the error, meant for programmatic parsing. See API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
// The date and time the error occurred.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry Log entries related to a specific work request.
type WorkRequestLogEntry struct {
// The description of an action that occurred.
Message *string `mandatory:"false" json:"message"`
// The date and time the log entry occurred.
Timestamp *string `mandatory:"false" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestOperationTypeEnum Enum with underlying type: string
type WorkRequestOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestOperationTypeEnum
const (
WorkRequestOperationTypeClusterCreate WorkRequestOperationTypeEnum = "CLUSTER_CREATE"
WorkRequestOperationTypeClusterUpdate WorkRequestOperationTypeEnum = "CLUSTER_UPDATE"
WorkRequestOperationTypeClusterDelete WorkRequestOperationTypeEnum = "CLUSTER_DELETE"
WorkRequestOperationTypeCreateNamespace WorkRequestOperationTypeEnum = "CREATE_NAMESPACE"
WorkRequestOperationTypeNodepoolCreate WorkRequestOperationTypeEnum = "NODEPOOL_CREATE"
WorkRequestOperationTypeNodepoolUpdate WorkRequestOperationTypeEnum = "NODEPOOL_UPDATE"
WorkRequestOperationTypeNodepoolDelete WorkRequestOperationTypeEnum = "NODEPOOL_DELETE"
WorkRequestOperationTypeNodepoolReconcile WorkRequestOperationTypeEnum = "NODEPOOL_RECONCILE"
WorkRequestOperationTypeNodepoolCycling WorkRequestOperationTypeEnum = "NODEPOOL_CYCLING"
WorkRequestOperationTypeWorkrequestCancel WorkRequestOperationTypeEnum = "WORKREQUEST_CANCEL"
WorkRequestOperationTypeVirtualnodepoolCreate WorkRequestOperationTypeEnum = "VIRTUALNODEPOOL_CREATE"
WorkRequestOperationTypeVirtualnodepoolUpdate WorkRequestOperationTypeEnum = "VIRTUALNODEPOOL_UPDATE"
WorkRequestOperationTypeVirtualnodepoolDelete WorkRequestOperationTypeEnum = "VIRTUALNODEPOOL_DELETE"
WorkRequestOperationTypeVirtualnodeDelete WorkRequestOperationTypeEnum = "VIRTUALNODE_DELETE"
WorkRequestOperationTypeEnableAddon WorkRequestOperationTypeEnum = "ENABLE_ADDON"
WorkRequestOperationTypeUpdateAddon WorkRequestOperationTypeEnum = "UPDATE_ADDON"
WorkRequestOperationTypeDisableAddon WorkRequestOperationTypeEnum = "DISABLE_ADDON"
WorkRequestOperationTypeReconcileAddon WorkRequestOperationTypeEnum = "RECONCILE_ADDON"
)
Set of constants representing the allowable values for WorkRequestOperationTypeEnum Deprecated
const (
WorkRequestSummaryOperationTypeClusterCreate WorkRequestOperationTypeEnum = "CLUSTER_CREATE"
WorkRequestSummaryOperationTypeClusterUpdate WorkRequestOperationTypeEnum = "CLUSTER_UPDATE"
WorkRequestSummaryOperationTypeClusterDelete WorkRequestOperationTypeEnum = "CLUSTER_DELETE"
WorkRequestSummaryOperationTypeCreateNamespace WorkRequestOperationTypeEnum = "CREATE_NAMESPACE"
WorkRequestSummaryOperationTypeNodepoolCreate WorkRequestOperationTypeEnum = "NODEPOOL_CREATE"
WorkRequestSummaryOperationTypeNodepoolUpdate WorkRequestOperationTypeEnum = "NODEPOOL_UPDATE"
WorkRequestSummaryOperationTypeNodepoolDelete WorkRequestOperationTypeEnum = "NODEPOOL_DELETE"
WorkRequestSummaryOperationTypeNodepoolReconcile WorkRequestOperationTypeEnum = "NODEPOOL_RECONCILE"
WorkRequestSummaryOperationTypeNodepoolCycling WorkRequestOperationTypeEnum = "NODEPOOL_CYCLING"
WorkRequestSummaryOperationTypeWorkrequestCancel WorkRequestOperationTypeEnum = "WORKREQUEST_CANCEL"
WorkRequestSummaryOperationTypeVirtualnodepoolCreate WorkRequestOperationTypeEnum = "VIRTUALNODEPOOL_CREATE"
WorkRequestSummaryOperationTypeVirtualnodepoolUpdate WorkRequestOperationTypeEnum = "VIRTUALNODEPOOL_UPDATE"
WorkRequestSummaryOperationTypeVirtualnodepoolDelete WorkRequestOperationTypeEnum = "VIRTUALNODEPOOL_DELETE"
WorkRequestSummaryOperationTypeVirtualnodeDelete WorkRequestOperationTypeEnum = "VIRTUALNODE_DELETE"
WorkRequestSummaryOperationTypeEnableAddon WorkRequestOperationTypeEnum = "ENABLE_ADDON"
WorkRequestSummaryOperationTypeUpdateAddon WorkRequestOperationTypeEnum = "UPDATE_ADDON"
WorkRequestSummaryOperationTypeDisableAddon WorkRequestOperationTypeEnum = "DISABLE_ADDON"
WorkRequestSummaryOperationTypeReconcileAddon WorkRequestOperationTypeEnum = "RECONCILE_ADDON"
)
func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)
GetMappingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum
WorkRequestResource The properties that define a work request resource.
type WorkRequestResource struct {
// The way in which this resource was affected by the work tracked by the work request.
ActionType WorkRequestResourceActionTypeEnum `mandatory:"false" json:"actionType,omitempty"`
// The resource type the work request affects.
EntityType *string `mandatory:"false" json:"entityType"`
// The OCID of the resource the work request affects.
Identifier *string `mandatory:"false" json:"identifier"`
// The URI path on which the user can issue a GET request to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResourceActionTypeEnum Enum with underlying type: string
type WorkRequestResourceActionTypeEnum string
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum
const (
WorkRequestResourceActionTypeCreated WorkRequestResourceActionTypeEnum = "CREATED"
WorkRequestResourceActionTypeUpdated WorkRequestResourceActionTypeEnum = "UPDATED"
WorkRequestResourceActionTypeDeleted WorkRequestResourceActionTypeEnum = "DELETED"
WorkRequestResourceActionTypeRelated WorkRequestResourceActionTypeEnum = "RELATED"
WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
WorkRequestResourceActionTypeFailed WorkRequestResourceActionTypeEnum = "FAILED"
WorkRequestResourceActionTypeCanceledCreate WorkRequestResourceActionTypeEnum = "CANCELED_CREATE"
WorkRequestResourceActionTypeCanceledUpdate WorkRequestResourceActionTypeEnum = "CANCELED_UPDATE"
WorkRequestResourceActionTypeCanceledDelete WorkRequestResourceActionTypeEnum = "CANCELED_DELETE"
)
func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)
GetMappingWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum
WorkRequestStatusEnum Enum with underlying type: string
type WorkRequestStatusEnum string
Set of constants representing the allowable values for WorkRequestStatusEnum
const (
WorkRequestStatusAccepted WorkRequestStatusEnum = "ACCEPTED"
WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
WorkRequestStatusFailed WorkRequestStatusEnum = "FAILED"
WorkRequestStatusSucceeded WorkRequestStatusEnum = "SUCCEEDED"
WorkRequestStatusCanceling WorkRequestStatusEnum = "CANCELING"
WorkRequestStatusCanceled WorkRequestStatusEnum = "CANCELED"
)
Set of constants representing the allowable values for WorkRequestStatusEnum Deprecated
const (
WorkRequestSummaryStatusAccepted WorkRequestStatusEnum = "ACCEPTED"
WorkRequestSummaryStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
WorkRequestSummaryStatusFailed WorkRequestStatusEnum = "FAILED"
WorkRequestSummaryStatusSucceeded WorkRequestStatusEnum = "SUCCEEDED"
WorkRequestSummaryStatusCanceling WorkRequestStatusEnum = "CANCELING"
WorkRequestSummaryStatusCanceled WorkRequestStatusEnum = "CANCELED"
)
func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)
GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum
WorkRequestSummary The properties that define a work request summary.
type WorkRequestSummary struct {
// The OCID of the work request.
Id *string `mandatory:"false" json:"id"`
// The type of work the work request is doing.
OperationType WorkRequestOperationTypeEnum `mandatory:"false" json:"operationType,omitempty"`
// The current status of the work request.
Status WorkRequestStatusEnum `mandatory:"false" json:"status,omitempty"`
// The OCID of the compartment in which the work request exists.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The resources this work request affects.
Resources []WorkRequestResource `mandatory:"false" json:"resources"`
// The time the work request was accepted.
TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`
// The time the work request was started.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The time the work request was finished.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummaryOperationTypeEnum is an alias to type: WorkRequestOperationTypeEnum Consider using WorkRequestOperationTypeEnum instead Deprecated
type WorkRequestSummaryOperationTypeEnum = WorkRequestOperationTypeEnum
WorkRequestSummaryStatusEnum is an alias to type: WorkRequestStatusEnum Consider using WorkRequestStatusEnum instead Deprecated
type WorkRequestSummaryStatusEnum = WorkRequestStatusEnum
WorkloadMapping The properties that define an workloadMapping.
type WorkloadMapping struct {
// The ocid of the workloadMapping.
Id *string `mandatory:"true" json:"id"`
// The OCID of the cluster.
ClusterId *string `mandatory:"true" json:"clusterId"`
// The namespace of the workloadMapping.
Namespace *string `mandatory:"true" json:"namespace"`
// The OCID of the mapped customer tenancy.
MappedTenancyId *string `mandatory:"true" json:"mappedTenancyId"`
// The OCID of the mapped customer compartment.
MappedCompartmentId *string `mandatory:"true" json:"mappedCompartmentId"`
// The time the cluster was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The state of the workloadMapping.
LifecycleState WorkloadMappingLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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"`
}
func (m WorkloadMapping) String() string
func (m WorkloadMapping) 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
WorkloadMappingLifecycleStateEnum Enum with underlying type: string
type WorkloadMappingLifecycleStateEnum string
Set of constants representing the allowable values for WorkloadMappingLifecycleStateEnum
const (
WorkloadMappingLifecycleStateCreating WorkloadMappingLifecycleStateEnum = "CREATING"
WorkloadMappingLifecycleStateActive WorkloadMappingLifecycleStateEnum = "ACTIVE"
WorkloadMappingLifecycleStateFailed WorkloadMappingLifecycleStateEnum = "FAILED"
WorkloadMappingLifecycleStateDeleting WorkloadMappingLifecycleStateEnum = "DELETING"
WorkloadMappingLifecycleStateDeleted WorkloadMappingLifecycleStateEnum = "DELETED"
WorkloadMappingLifecycleStateUpdating WorkloadMappingLifecycleStateEnum = "UPDATING"
)
func GetMappingWorkloadMappingLifecycleStateEnum(val string) (WorkloadMappingLifecycleStateEnum, bool)
GetMappingWorkloadMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkloadMappingLifecycleStateEnumValues() []WorkloadMappingLifecycleStateEnum
GetWorkloadMappingLifecycleStateEnumValues Enumerates the set of values for WorkloadMappingLifecycleStateEnum
WorkloadMappingSummary The properties that define an workloadMapping summary.
type WorkloadMappingSummary struct {
// The ocid of the workloadMapping.
Id *string `mandatory:"true" json:"id"`
// The OCID of the cluster.
ClusterId *string `mandatory:"true" json:"clusterId"`
// The namespace of the workloadMapping.
Namespace *string `mandatory:"true" json:"namespace"`
// The OCID of the mapped customer tenancy.
MappedTenancyId *string `mandatory:"true" json:"mappedTenancyId"`
// The OCID of the mapped customer compartment.
MappedCompartmentId *string `mandatory:"true" json:"mappedCompartmentId"`
// The time the cluster was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The state of the workloadMapping.
LifecycleState WorkloadMappingLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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"`
}
func (m WorkloadMappingSummary) String() string
func (m WorkloadMappingSummary) 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