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
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
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
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 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"` // 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. 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"` }
func (m Cluster) String() string
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"` // 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"` }
func (m ClusterCreateOptions) String() string
ClusterEndpoints The properties that define endpoints for a cluster.
type ClusterEndpoints struct { // The Kubernetes API server endpoint. Kubernetes *string `mandatory:"false" json:"kubernetes"` }
func (m ClusterEndpoints) String() string
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
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"` }
func (m ClusterMetadata) String() string
ClusterOptions Options for creating or updating clusters.
type ClusterOptions struct { // Available Kubernetes versions. KubernetesVersions []string `mandatory:"false" json:"kubernetesVersions"` }
func (m ClusterOptions) String() string
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 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"` // 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. 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"` }
func (m ClusterSummary) String() string
ClusterSummaryLifecycleStateEnum is an alias to type: ClusterLifecycleStateEnum Consider using ClusterLifecycleStateEnum instead Deprecated
type ClusterSummaryLifecycleStateEnum = ClusterLifecycleStateEnum
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) 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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/CreateCluster.go.html to see an example of how to use CreateCluster API.
func (client ContainerEngineClient) CreateKubeconfig(ctx context.Context, request CreateKubeconfigRequest) (response CreateKubeconfigResponse, err error)
CreateKubeconfig Create the Kubeconfig YAML for a cluster.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/CreateKubeconfig.go.html to see an example of how to use CreateKubeconfig API.
func (client ContainerEngineClient) CreateNodePool(ctx context.Context, request CreateNodePoolRequest) (response CreateNodePoolResponse, err error)
CreateNodePool Create a new node pool.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/CreateNodePool.go.html to see an example of how to use CreateNodePool API.
func (client ContainerEngineClient) DeleteCluster(ctx context.Context, request DeleteClusterRequest) (response DeleteClusterResponse, err error)
DeleteCluster Delete a cluster.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/DeleteCluster.go.html to see an example of how to use DeleteCluster API.
func (client ContainerEngineClient) DeleteNodePool(ctx context.Context, request DeleteNodePoolRequest) (response DeleteNodePoolResponse, err error)
DeleteNodePool Delete a node pool.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/DeleteNodePool.go.html to see an example of how to use DeleteNodePool API.
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/DeleteWorkRequest.go.html to see an example of how to use DeleteWorkRequest API.
func (client ContainerEngineClient) GetCluster(ctx context.Context, request GetClusterRequest) (response GetClusterResponse, err error)
GetCluster Get the details of a cluster.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/GetCluster.go.html to see an example of how to use GetCluster API.
func (client ContainerEngineClient) GetClusterOptions(ctx context.Context, request GetClusterOptionsRequest) (response GetClusterOptionsResponse, err error)
GetClusterOptions Get options available for clusters.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/GetClusterOptions.go.html to see an example of how to use GetClusterOptions API.
func (client ContainerEngineClient) GetNodePool(ctx context.Context, request GetNodePoolRequest) (response GetNodePoolResponse, err error)
GetNodePool Get the details of a node pool.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/GetNodePool.go.html to see an example of how to use GetNodePool API.
func (client ContainerEngineClient) GetNodePoolOptions(ctx context.Context, request GetNodePoolOptionsRequest) (response GetNodePoolOptionsResponse, err error)
GetNodePoolOptions Get options available for node pools.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/GetNodePoolOptions.go.html to see an example of how to use GetNodePoolOptions API.
func (client ContainerEngineClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Get the details of a work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/ListClusters.go.html to see an example of how to use ListClusters API.
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/ListNodePools.go.html to see an example of how to use ListNodePools API.
func (client ContainerEngineClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Get the errors of a work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.
func (client ContainerEngineClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Get the logs of a work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.
func (client ContainerEngineClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests List all work requests in a compartment.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.
func (client *ContainerEngineClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ContainerEngineClient) UpdateCluster(ctx context.Context, request UpdateClusterRequest) (response UpdateClusterResponse, err error)
UpdateCluster Update the details of a cluster.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/UpdateCluster.go.html to see an example of how to use UpdateCluster API.
func (client ContainerEngineClient) UpdateNodePool(ctx context.Context, request UpdateNodePoolRequest) (response UpdateNodePoolResponse, err error)
UpdateNodePool Update the details of a node pool.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/UpdateNodePool.go.html to see an example of how to use UpdateNodePool API.
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 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"` // Optional attributes for the cluster. Options *ClusterCreateOptions `mandatory:"false" json:"options"` }
func (m CreateClusterDetails) String() string
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"` }
func (m CreateClusterKubeconfigContentDetails) String() string
CreateClusterRequest wrapper for the CreateCluster operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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
CreateKubeconfigRequest wrapper for the CreateKubeconfig operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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 version of Kubernetes to install on the nodes in the node pool. KubernetesVersion *string `mandatory:"true" json:"kubernetesVersion"` // The name of the node shape of the nodes in the node pool. NodeShape *string `mandatory:"true" json:"nodeShape"` // 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"` }
func (m CreateNodePoolDetails) String() string
func (m *CreateNodePoolDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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"` }
func (m CreateNodePoolNodeConfigDetails) String() string
CreateNodePoolRequest wrapper for the CreateNodePool operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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.cloud.oracle.com/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
DeleteClusterRequest wrapper for the DeleteCluster operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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"` // 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) HTTPRequest(method, path 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
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
DeleteWorkRequestRequest wrapper for the DeleteWorkRequest operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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
GetClusterOptionsRequest wrapper for the GetClusterOptions operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/containerengine/GetClusterOptions.go.html to see an example of how to use GetClusterOptionsRequest.
type GetClusterOptionsRequest struct { // The id of the option set to retrieve. Only "all" is supported. 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) HTTPRequest(method, path 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
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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
GetNodePoolOptionsRequest wrapper for the GetNodePoolOptions operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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
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
KubernetesNetworkConfig The properties that define the network configuration for Kubernetes.
type KubernetesNetworkConfig struct { // The CIDR block for Kubernetes pods. PodsCidr *string `mandatory:"false" json:"podsCidr"` // The CIDR block for Kubernetes services. ServicesCidr *string `mandatory:"false" json:"servicesCidr"` }
func (m KubernetesNetworkConfig) String() string
ListClustersLifecycleStateEnum Enum with underlying type: string
type ListClustersLifecycleStateEnum string
Set of constants representing the allowable values for ListClustersLifecycleStateEnum
const ( ListClustersLifecycleStateCreating ListClustersLifecycleStateEnum = "CREATING" ListClustersLifecycleStateActive ListClustersLifecycleStateEnum = "ACTIVE" ListClustersLifecycleStateFailed ListClustersLifecycleStateEnum = "FAILED" ListClustersLifecycleStateDeleting ListClustersLifecycleStateEnum = "DELETING" ListClustersLifecycleStateDeleted ListClustersLifecycleStateEnum = "DELETED" ListClustersLifecycleStateUpdating ListClustersLifecycleStateEnum = "UPDATING" )
func GetListClustersLifecycleStateEnumValues() []ListClustersLifecycleStateEnum
GetListClustersLifecycleStateEnumValues Enumerates the set of values for ListClustersLifecycleStateEnum
ListClustersRequest wrapper for the ListClusters operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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. LifecycleState []ListClustersLifecycleStateEnum `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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // For list pagination. The value of the `opc-next-page` response header from the previous "List" call. // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Page *string `mandatory:"false" contributesTo:"query" name:"page"` // 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) HTTPRequest(method, path 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
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.cloud.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
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
ListNodePoolsRequest wrapper for the ListNodePools operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // For list pagination. The value of the `opc-next-page` response header from the previous "List" call. // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Page *string `mandatory:"false" contributesTo:"query" name:"page"` // 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"` // 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) HTTPRequest(method, path 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
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.cloud.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
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
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // For list pagination. The value of the `opc-next-page` response header from the previous "List" call. // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Page *string `mandatory:"false" contributesTo:"query" name:"page"` // 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) HTTPRequest(method, path 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
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
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.cloud.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
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
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"` // The state of the node. 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
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.cloud.oracle.com/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
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 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 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"` }
func (m NodePool) String() string
func (m *NodePool) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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 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"` }
func (m NodePoolNodeConfigDetails) String() string
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
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"` }
func (m NodePoolPlacementConfigDetails) String() string
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 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"` }
func (m NodePoolSummary) String() string
func (m *NodePoolSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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.cloud.oracle.com/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
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 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.cloud.oracle.com/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
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
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 GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
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"` }
func (m UpdateClusterDetails) 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"` }
func (m UpdateClusterOptionsDetails) String() string
UpdateClusterRequest wrapper for the UpdateCluster operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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
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"` }
func (m UpdateNodePoolDetails) String() string
func (m *UpdateNodePoolDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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 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"` }
func (m UpdateNodePoolNodeConfigDetails) String() string
UpdateNodePoolRequest wrapper for the UpdateNodePool operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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"` // 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) HTTPRequest(method, path 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
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.cloud.oracle.com/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
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
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.cloud.oracle.com/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
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
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" WorkRequestOperationTypeNodepoolCreate WorkRequestOperationTypeEnum = "NODEPOOL_CREATE" WorkRequestOperationTypeNodepoolUpdate WorkRequestOperationTypeEnum = "NODEPOOL_UPDATE" WorkRequestOperationTypeNodepoolDelete WorkRequestOperationTypeEnum = "NODEPOOL_DELETE" WorkRequestOperationTypeWorkrequestCancel WorkRequestOperationTypeEnum = "WORKREQUEST_CANCEL" )
Set of constants representing the allowable values for WorkRequestOperationTypeEnum Deprecated
const ( WorkRequestSummaryOperationTypeClusterCreate WorkRequestOperationTypeEnum = "CLUSTER_CREATE" WorkRequestSummaryOperationTypeClusterUpdate WorkRequestOperationTypeEnum = "CLUSTER_UPDATE" WorkRequestSummaryOperationTypeClusterDelete WorkRequestOperationTypeEnum = "CLUSTER_DELETE" WorkRequestSummaryOperationTypeNodepoolCreate WorkRequestOperationTypeEnum = "NODEPOOL_CREATE" WorkRequestSummaryOperationTypeNodepoolUpdate WorkRequestOperationTypeEnum = "NODEPOOL_UPDATE" WorkRequestSummaryOperationTypeNodepoolDelete WorkRequestOperationTypeEnum = "NODEPOOL_DELETE" WorkRequestSummaryOperationTypeWorkrequestCancel WorkRequestOperationTypeEnum = "WORKREQUEST_CANCEL" )
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
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" )
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 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
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