containerengine

package
v24.3.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Sep 8, 2020 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var GetClusterSummaryLifecycleStateEnumValues = GetClusterLifecycleStateEnumValues

GetClusterSummaryLifecycleStateEnumValues Enumerates the set of values for ClusterLifecycleStateEnum Consider using GetClusterLifecycleStateEnumValue Deprecated

View Source 
var GetWorkRequestSummaryOperationTypeEnumValues = GetWorkRequestOperationTypeEnumValues

GetWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum Consider using GetWorkRequestOperationTypeEnumValue Deprecated

View Source 
var GetWorkRequestSummaryStatusEnumValues = GetWorkRequestStatusEnumValues

GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum Consider using GetWorkRequestStatusEnumValue Deprecated

Functions

This section is empty.

Types

type AddOnOptions 

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

AddOnOptions The properties that define options for supported add-ons.

func (AddOnOptions) String 

func (m AddOnOptions) String() string

type AdmissionControllerOptions 

type AdmissionControllerOptions struct {

	// Whether or not to enable the Pod Security Policy admission controller.
	IsPodSecurityPolicyEnabled *bool `mandatory:"false" json:"isPodSecurityPolicyEnabled"`
}

AdmissionControllerOptions The properties that define supported admission controllers.

func (AdmissionControllerOptions) String 

func (m AdmissionControllerOptions) String() string

type Cluster 

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

Cluster A Kubernetes cluster. Avoid entering confidential information.

func (Cluster) String 

func (m Cluster) String() string

type ClusterCreateOptions 

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

ClusterCreateOptions The properties that define extra options for a cluster.

func (ClusterCreateOptions) String 

func (m ClusterCreateOptions) String() string

type ClusterEndpoints 

type ClusterEndpoints struct {

	// The Kubernetes API server endpoint.
	Kubernetes *string `mandatory:"false" json:"kubernetes"`
}

ClusterEndpoints The properties that define endpoints for a cluster.

func (ClusterEndpoints) String 

func (m ClusterEndpoints) String() string

type ClusterLifecycleStateEnum 

type ClusterLifecycleStateEnum string

ClusterLifecycleStateEnum Enum with underlying type: string 

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 

const (
	ClusterSummaryLifecycleStateCreating ClusterLifecycleStateEnum = "CREATING"
	ClusterSummaryLifecycleStateActive   ClusterLifecycleStateEnum = "ACTIVE"
	ClusterSummaryLifecycleStateFailed   ClusterLifecycleStateEnum = "FAILED"
	ClusterSummaryLifecycleStateDeleting ClusterLifecycleStateEnum = "DELETING"
	ClusterSummaryLifecycleStateDeleted  ClusterLifecycleStateEnum = "DELETED"
	ClusterSummaryLifecycleStateUpdating ClusterLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for ClusterLifecycleStateEnum Deprecated

func GetClusterLifecycleStateEnumValues 

func GetClusterLifecycleStateEnumValues() []ClusterLifecycleStateEnum

GetClusterLifecycleStateEnumValues Enumerates the set of values for ClusterLifecycleStateEnum

type ClusterMetadata 

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

ClusterMetadata The properties that define meta data for a cluster.

func (ClusterMetadata) String 

func (m ClusterMetadata) String() string

type ClusterOptions 

type ClusterOptions struct {

	// Available Kubernetes versions.
	KubernetesVersions []string `mandatory:"false" json:"kubernetesVersions"`
}

ClusterOptions Options for creating or updating clusters.

func (ClusterOptions) String 

func (m ClusterOptions) String() string

type ClusterSummary 

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

ClusterSummary The properties that define a cluster summary.

func (ClusterSummary) String 

func (m ClusterSummary) String() string

type ClusterSummaryLifecycleStateEnum 

type ClusterSummaryLifecycleStateEnum = ClusterLifecycleStateEnum

ClusterSummaryLifecycleStateEnum is an alias to type: ClusterLifecycleStateEnum Consider using ClusterLifecycleStateEnum instead Deprecated

type ContainerEngineClient 

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

ContainerEngineClient a client for ContainerEngine

func NewContainerEngineClientWithConfigurationProvider 

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 

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 (*ContainerEngineClient) ConfigurationProvider 

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

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

func (ContainerEngineClient) CreateCluster 

func (client ContainerEngineClient) CreateCluster(ctx context.Context, request CreateClusterRequest) (response CreateClusterResponse, err error)

CreateCluster Create a new cluster.

func (ContainerEngineClient) CreateKubeconfig 

func (client ContainerEngineClient) CreateKubeconfig(ctx context.Context, request CreateKubeconfigRequest) (response CreateKubeconfigResponse, err error)

CreateKubeconfig Create the Kubeconfig YAML for a cluster.

func (ContainerEngineClient) CreateNodePool 

func (client ContainerEngineClient) CreateNodePool(ctx context.Context, request CreateNodePoolRequest) (response CreateNodePoolResponse, err error)

CreateNodePool Create a new node pool.

func (ContainerEngineClient) DeleteCluster 

func (client ContainerEngineClient) DeleteCluster(ctx context.Context, request DeleteClusterRequest) (response DeleteClusterResponse, err error)

DeleteCluster Delete a cluster.

func (ContainerEngineClient) DeleteNodePool 

func (client ContainerEngineClient) DeleteNodePool(ctx context.Context, request DeleteNodePoolRequest) (response DeleteNodePoolResponse, err error)

DeleteNodePool Delete a node pool.

func (ContainerEngineClient) DeleteWorkRequest 

func (client ContainerEngineClient) DeleteWorkRequest(ctx context.Context, request DeleteWorkRequestRequest) (response DeleteWorkRequestResponse, err error)

DeleteWorkRequest Cancel a work request that has not started.

func (ContainerEngineClient) GetCluster 

func (client ContainerEngineClient) GetCluster(ctx context.Context, request GetClusterRequest) (response GetClusterResponse, err error)

GetCluster Get the details of a cluster.

func (ContainerEngineClient) GetClusterOptions 

func (client ContainerEngineClient) GetClusterOptions(ctx context.Context, request GetClusterOptionsRequest) (response GetClusterOptionsResponse, err error)

GetClusterOptions Get options available for clusters.

func (ContainerEngineClient) GetNodePool 

func (client ContainerEngineClient) GetNodePool(ctx context.Context, request GetNodePoolRequest) (response GetNodePoolResponse, err error)

GetNodePool Get the details of a node pool.

func (ContainerEngineClient) GetNodePoolOptions 

func (client ContainerEngineClient) GetNodePoolOptions(ctx context.Context, request GetNodePoolOptionsRequest) (response GetNodePoolOptionsResponse, err error)

GetNodePoolOptions Get options available for node pools.

func (ContainerEngineClient) GetWorkRequest 

func (client ContainerEngineClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Get the details of a work request.

func (ContainerEngineClient) ListClusters 

func (client ContainerEngineClient) ListClusters(ctx context.Context, request ListClustersRequest) (response ListClustersResponse, err error)

ListClusters List all the cluster objects in a compartment.

func (ContainerEngineClient) ListNodePools 

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.

func (ContainerEngineClient) ListWorkRequestErrors 

func (client ContainerEngineClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)

ListWorkRequestErrors Get the errors of a work request.

func (ContainerEngineClient) ListWorkRequestLogs 

func (client ContainerEngineClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)

ListWorkRequestLogs Get the logs of a work request.

func (ContainerEngineClient) ListWorkRequests 

func (client ContainerEngineClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests List all work requests in a compartment.

func (*ContainerEngineClient) SetRegion 

func (client *ContainerEngineClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (ContainerEngineClient) UpdateCluster 

func (client ContainerEngineClient) UpdateCluster(ctx context.Context, request UpdateClusterRequest) (response UpdateClusterResponse, err error)

UpdateCluster Update the details of a cluster.

func (ContainerEngineClient) UpdateNodePool 

func (client ContainerEngineClient) UpdateNodePool(ctx context.Context, request UpdateNodePoolRequest) (response UpdateNodePoolResponse, err error)

UpdateNodePool Update the details of a node pool.

type CreateClusterDetails 

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

CreateClusterDetails The properties that define a request to create a cluster.

func (CreateClusterDetails) String 

func (m CreateClusterDetails) String() string

type CreateClusterKubeconfigContentDetails 

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

CreateClusterKubeconfigContentDetails The properties that define a request to create a cluster kubeconfig.

func (CreateClusterKubeconfigContentDetails) String 

func (m CreateClusterKubeconfigContentDetails) String() string

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

CreateClusterRequest wrapper for the CreateCluster operation

func (CreateClusterRequest) HTTPRequest 

func (request CreateClusterRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateClusterRequest) RetryPolicy 

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

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

func (CreateClusterRequest) String 

func (request CreateClusterRequest) String() string

type CreateClusterResponse 

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

CreateClusterResponse wrapper for the CreateCluster operation

func (CreateClusterResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateClusterResponse) String 

func (response CreateClusterResponse) String() string

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

CreateKubeconfigRequest wrapper for the CreateKubeconfig operation

func (CreateKubeconfigRequest) HTTPRequest 

func (request CreateKubeconfigRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateKubeconfigRequest) RetryPolicy 

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

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

func (CreateKubeconfigRequest) String 

func (request CreateKubeconfigRequest) String() string

type CreateKubeconfigResponse 

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

CreateKubeconfigResponse wrapper for the CreateKubeconfig operation

func (CreateKubeconfigResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateKubeconfigResponse) String 

func (response CreateKubeconfigResponse) String() string

type CreateNodePoolDetails 

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

CreateNodePoolDetails The properties that define a request to create a node pool.

func (CreateNodePoolDetails) String 

func (m CreateNodePoolDetails) String() string

func (*CreateNodePoolDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type CreateNodePoolNodeConfigDetails 

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

CreateNodePoolNodeConfigDetails The size and placement configuration of nodes in the node pool.

func (CreateNodePoolNodeConfigDetails) String 

func (m CreateNodePoolNodeConfigDetails) String() string

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

CreateNodePoolRequest wrapper for the CreateNodePool operation

func (CreateNodePoolRequest) HTTPRequest 

func (request CreateNodePoolRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateNodePoolRequest) RetryPolicy 

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

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

func (CreateNodePoolRequest) String 

func (request CreateNodePoolRequest) String() string

type CreateNodePoolResponse 

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

CreateNodePoolResponse wrapper for the CreateNodePool operation

func (CreateNodePoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateNodePoolResponse) String 

func (response CreateNodePoolResponse) String() string

type CreateNodeShapeConfigDetails 

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

CreateNodeShapeConfigDetails The shape configuration of the nodes.

func (CreateNodeShapeConfigDetails) String 

func (m CreateNodeShapeConfigDetails) String() string

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

DeleteClusterRequest wrapper for the DeleteCluster operation

func (DeleteClusterRequest) HTTPRequest 

func (request DeleteClusterRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteClusterRequest) RetryPolicy 

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

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

func (DeleteClusterRequest) String 

func (request DeleteClusterRequest) String() string

type DeleteClusterResponse 

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

DeleteClusterResponse wrapper for the DeleteCluster operation

func (DeleteClusterResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteClusterResponse) String 

func (response DeleteClusterResponse) String() string

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

DeleteNodePoolRequest wrapper for the DeleteNodePool operation

func (DeleteNodePoolRequest) HTTPRequest 

func (request DeleteNodePoolRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteNodePoolRequest) RetryPolicy 

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

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

func (DeleteNodePoolRequest) String 

func (request DeleteNodePoolRequest) String() string

type DeleteNodePoolResponse 

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

DeleteNodePoolResponse wrapper for the DeleteNodePool operation

func (DeleteNodePoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteNodePoolResponse) String 

func (response DeleteNodePoolResponse) String() string

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

DeleteWorkRequestRequest wrapper for the DeleteWorkRequest operation

func (DeleteWorkRequestRequest) HTTPRequest 

func (request DeleteWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteWorkRequestRequest) RetryPolicy 

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

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

func (DeleteWorkRequestRequest) String 

func (request DeleteWorkRequestRequest) String() string

type DeleteWorkRequestResponse 

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

DeleteWorkRequestResponse wrapper for the DeleteWorkRequest operation

func (DeleteWorkRequestResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteWorkRequestResponse) String 

func (response DeleteWorkRequestResponse) String() string

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

GetClusterOptionsRequest wrapper for the GetClusterOptions operation

func (GetClusterOptionsRequest) HTTPRequest 

func (request GetClusterOptionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetClusterOptionsRequest) RetryPolicy 

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

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

func (GetClusterOptionsRequest) String 

func (request GetClusterOptionsRequest) String() string

type GetClusterOptionsResponse 

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

GetClusterOptionsResponse wrapper for the GetClusterOptions operation

func (GetClusterOptionsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetClusterOptionsResponse) String 

func (response GetClusterOptionsResponse) String() string

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

GetClusterRequest wrapper for the GetCluster operation

func (GetClusterRequest) HTTPRequest 

func (request GetClusterRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetClusterRequest) RetryPolicy 

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

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

func (GetClusterRequest) String 

func (request GetClusterRequest) String() string

type GetClusterResponse 

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

GetClusterResponse wrapper for the GetCluster operation

func (GetClusterResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetClusterResponse) String 

func (response GetClusterResponse) String() string

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

GetNodePoolOptionsRequest wrapper for the GetNodePoolOptions operation

func (GetNodePoolOptionsRequest) HTTPRequest 

func (request GetNodePoolOptionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetNodePoolOptionsRequest) RetryPolicy 

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

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

func (GetNodePoolOptionsRequest) String 

func (request GetNodePoolOptionsRequest) String() string

type GetNodePoolOptionsResponse 

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

GetNodePoolOptionsResponse wrapper for the GetNodePoolOptions operation

func (GetNodePoolOptionsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetNodePoolOptionsResponse) String 

func (response GetNodePoolOptionsResponse) String() string

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

GetNodePoolRequest wrapper for the GetNodePool operation

func (GetNodePoolRequest) HTTPRequest 

func (request GetNodePoolRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetNodePoolRequest) RetryPolicy 

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

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

func (GetNodePoolRequest) String 

func (request GetNodePoolRequest) String() string

type GetNodePoolResponse 

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

GetNodePoolResponse wrapper for the GetNodePool operation

func (GetNodePoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetNodePoolResponse) String 

func (response GetNodePoolResponse) String() string

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

GetWorkRequestRequest wrapper for the GetWorkRequest operation

func (GetWorkRequestRequest) HTTPRequest 

func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy 

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

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

func (GetWorkRequestRequest) String 

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse 

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String 

func (response GetWorkRequestResponse) String() string

type KeyValue 

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

KeyValue The properties that define a key value pair.

func (KeyValue) String 

func (m KeyValue) String() string

type KubernetesNetworkConfig 

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

KubernetesNetworkConfig The properties that define the network configuration for Kubernetes.

func (KubernetesNetworkConfig) String 

func (m KubernetesNetworkConfig) String() string

type ListClustersLifecycleStateEnum 

type ListClustersLifecycleStateEnum string

ListClustersLifecycleStateEnum Enum with underlying type: string 

const (
	ListClustersLifecycleStateCreating ListClustersLifecycleStateEnum = "CREATING"
	ListClustersLifecycleStateActive   ListClustersLifecycleStateEnum = "ACTIVE"
	ListClustersLifecycleStateFailed   ListClustersLifecycleStateEnum = "FAILED"
	ListClustersLifecycleStateDeleting ListClustersLifecycleStateEnum = "DELETING"
	ListClustersLifecycleStateDeleted  ListClustersLifecycleStateEnum = "DELETED"
	ListClustersLifecycleStateUpdating ListClustersLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for ListClustersLifecycleStateEnum

func GetListClustersLifecycleStateEnumValues 

func GetListClustersLifecycleStateEnumValues() []ListClustersLifecycleStateEnum

GetListClustersLifecycleStateEnumValues Enumerates the set of values for ListClustersLifecycleStateEnum

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

ListClustersRequest wrapper for the ListClusters operation

func (ListClustersRequest) HTTPRequest 

func (request ListClustersRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListClustersRequest) RetryPolicy 

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

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

func (ListClustersRequest) String 

func (request ListClustersRequest) String() string

type ListClustersResponse 

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

ListClustersResponse wrapper for the ListClusters operation

func (ListClustersResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListClustersResponse) String 

func (response ListClustersResponse) String() string

type ListClustersSortByEnum 

type ListClustersSortByEnum string

ListClustersSortByEnum Enum with underlying type: string 

const (
	ListClustersSortById          ListClustersSortByEnum = "ID"
	ListClustersSortByName        ListClustersSortByEnum = "NAME"
	ListClustersSortByTimeCreated ListClustersSortByEnum = "TIME_CREATED"
)

Set of constants representing the allowable values for ListClustersSortByEnum

func GetListClustersSortByEnumValues 

func GetListClustersSortByEnumValues() []ListClustersSortByEnum

GetListClustersSortByEnumValues Enumerates the set of values for ListClustersSortByEnum

type ListClustersSortOrderEnum 

type ListClustersSortOrderEnum string

ListClustersSortOrderEnum Enum with underlying type: string 

const (
	ListClustersSortOrderAsc  ListClustersSortOrderEnum = "ASC"
	ListClustersSortOrderDesc ListClustersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListClustersSortOrderEnum

func GetListClustersSortOrderEnumValues 

func GetListClustersSortOrderEnumValues() []ListClustersSortOrderEnum

GetListClustersSortOrderEnumValues Enumerates the set of values for ListClustersSortOrderEnum

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

ListNodePoolsRequest wrapper for the ListNodePools operation

func (ListNodePoolsRequest) HTTPRequest 

func (request ListNodePoolsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListNodePoolsRequest) RetryPolicy 

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

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

func (ListNodePoolsRequest) String 

func (request ListNodePoolsRequest) String() string

type ListNodePoolsResponse 

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

ListNodePoolsResponse wrapper for the ListNodePools operation

func (ListNodePoolsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListNodePoolsResponse) String 

func (response ListNodePoolsResponse) String() string

type ListNodePoolsSortByEnum 

type ListNodePoolsSortByEnum string

ListNodePoolsSortByEnum Enum with underlying type: string 

const (
	ListNodePoolsSortById          ListNodePoolsSortByEnum = "ID"
	ListNodePoolsSortByName        ListNodePoolsSortByEnum = "NAME"
	ListNodePoolsSortByTimeCreated ListNodePoolsSortByEnum = "TIME_CREATED"
)

Set of constants representing the allowable values for ListNodePoolsSortByEnum

func GetListNodePoolsSortByEnumValues 

func GetListNodePoolsSortByEnumValues() []ListNodePoolsSortByEnum

GetListNodePoolsSortByEnumValues Enumerates the set of values for ListNodePoolsSortByEnum

type ListNodePoolsSortOrderEnum 

type ListNodePoolsSortOrderEnum string

ListNodePoolsSortOrderEnum Enum with underlying type: string 

const (
	ListNodePoolsSortOrderAsc  ListNodePoolsSortOrderEnum = "ASC"
	ListNodePoolsSortOrderDesc ListNodePoolsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListNodePoolsSortOrderEnum

func GetListNodePoolsSortOrderEnumValues 

func GetListNodePoolsSortOrderEnumValues() []ListNodePoolsSortOrderEnum

GetListNodePoolsSortOrderEnumValues Enumerates the set of values for ListNodePoolsSortOrderEnum

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

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsRequest) HTTPRequest 

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy 

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

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

func (ListWorkRequestErrorsRequest) String 

func (request ListWorkRequestErrorsRequest) String() string

type ListWorkRequestErrorsResponse 

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String 

func (response ListWorkRequestErrorsResponse) String() string

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

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsRequest) HTTPRequest 

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy 

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

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

func (ListWorkRequestLogsRequest) String 

func (request ListWorkRequestLogsRequest) String() string

type ListWorkRequestLogsResponse 

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String 

func (response ListWorkRequestLogsResponse) String() string

type 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 []ListWorkRequestsStatusEnum `contributesTo:"query" name:"status" omitEmpty:"true" 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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

func (ListWorkRequestsRequest) HTTPRequest 

func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy 

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

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

func (ListWorkRequestsRequest) String 

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResourceTypeEnum 

type ListWorkRequestsResourceTypeEnum string

ListWorkRequestsResourceTypeEnum Enum with underlying type: string 

const (
	ListWorkRequestsResourceTypeCluster  ListWorkRequestsResourceTypeEnum = "CLUSTER"
	ListWorkRequestsResourceTypeNodepool ListWorkRequestsResourceTypeEnum = "NODEPOOL"
)

Set of constants representing the allowable values for ListWorkRequestsResourceTypeEnum

func GetListWorkRequestsResourceTypeEnumValues 

func GetListWorkRequestsResourceTypeEnumValues() []ListWorkRequestsResourceTypeEnum

GetListWorkRequestsResourceTypeEnumValues Enumerates the set of values for ListWorkRequestsResourceTypeEnum

type ListWorkRequestsResponse 

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String 

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum 

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortById            ListWorkRequestsSortByEnum = "ID"
	ListWorkRequestsSortByOperationType ListWorkRequestsSortByEnum = "OPERATION_TYPE"
	ListWorkRequestsSortByStatus        ListWorkRequestsSortByEnum = "STATUS"
	ListWorkRequestsSortByTimeAccepted  ListWorkRequestsSortByEnum = "TIME_ACCEPTED"
	ListWorkRequestsSortByTimeStarted   ListWorkRequestsSortByEnum = "TIME_STARTED"
	ListWorkRequestsSortByTimeFinished  ListWorkRequestsSortByEnum = "TIME_FINISHED"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues 

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

type ListWorkRequestsSortOrderEnum 

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues 

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

type ListWorkRequestsStatusEnum 

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues 

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

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

Node The properties that define a node.

func (Node) String 

func (m Node) String() string

type NodeError 

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

NodeError The properties that define an upstream error while managing a node.

func (NodeError) String 

func (m NodeError) String() string

type NodeLifecycleStateEnum 

type NodeLifecycleStateEnum string

NodeLifecycleStateEnum Enum with underlying type: string 

const (
	NodeLifecycleStateCreating NodeLifecycleStateEnum = "CREATING"
	NodeLifecycleStateActive   NodeLifecycleStateEnum = "ACTIVE"
	NodeLifecycleStateUpdating NodeLifecycleStateEnum = "UPDATING"
	NodeLifecycleStateDeleting NodeLifecycleStateEnum = "DELETING"
	NodeLifecycleStateDeleted  NodeLifecycleStateEnum = "DELETED"
	NodeLifecycleStateFailing  NodeLifecycleStateEnum = "FAILING"
	NodeLifecycleStateInactive NodeLifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for NodeLifecycleStateEnum

func GetNodeLifecycleStateEnumValues 

func GetNodeLifecycleStateEnumValues() []NodeLifecycleStateEnum

GetNodeLifecycleStateEnumValues Enumerates the set of values for NodeLifecycleStateEnum

type NodePool 

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

NodePool A pool of compute nodes attached to a cluster. Avoid entering confidential information.

func (NodePool) String 

func (m NodePool) String() string

func (*NodePool) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type NodePoolNodeConfigDetails 

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

NodePoolNodeConfigDetails The size and placement configuration of nodes in the node pool.

func (NodePoolNodeConfigDetails) String 

func (m NodePoolNodeConfigDetails) String() string

type NodePoolOptions 

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

NodePoolOptions Options for creating or updating node pools.

func (NodePoolOptions) String 

func (m NodePoolOptions) String() string

func (*NodePoolOptions) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type NodePoolPlacementConfigDetails 

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

NodePoolPlacementConfigDetails The location where a node pool will place nodes.

func (NodePoolPlacementConfigDetails) String 

func (m NodePoolPlacementConfigDetails) String() string

type NodePoolSummary 

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

NodePoolSummary The properties that define a node pool summary.

func (NodePoolSummary) String 

func (m NodePoolSummary) String() string

func (*NodePoolSummary) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type NodeShapeConfig 

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

NodeShapeConfig The shape configuration of the nodes.

func (NodeShapeConfig) String 

func (m NodeShapeConfig) String() string

type NodeSourceDetails 

type NodeSourceDetails interface {
}

NodeSourceDetails The details of the node's source.

type NodeSourceOption 

type NodeSourceOption interface {

	// The user-friendly name of the entity corresponding to the OCID.
	GetSourceName() *string
}

NodeSourceOption The source option for the node.

type NodeSourceTypeEnum 

type NodeSourceTypeEnum string

NodeSourceTypeEnum Enum with underlying type: string 

const (
	NodeSourceTypeImage NodeSourceTypeEnum = "IMAGE"
)

Set of constants representing the allowable values for NodeSourceTypeEnum

func GetNodeSourceTypeEnumValues 

func GetNodeSourceTypeEnumValues() []NodeSourceTypeEnum

GetNodeSourceTypeEnumValues Enumerates the set of values for NodeSourceTypeEnum

type NodeSourceViaImageDetails 

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

NodeSourceViaImageDetails Details of the image running on the node.

func (NodeSourceViaImageDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (NodeSourceViaImageDetails) String 

func (m NodeSourceViaImageDetails) String() string

type NodeSourceViaImageOption 

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

NodeSourceViaImageOption An image can be specified as the source of nodes when launching a node pool using the `nodeSourceDetails` object.

func (NodeSourceViaImageOption) GetSourceName 

func (m NodeSourceViaImageOption) GetSourceName() *string

GetSourceName returns SourceName

func (NodeSourceViaImageOption) MarshalJSON 

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

MarshalJSON marshals to json representation

func (NodeSourceViaImageOption) String 

func (m NodeSourceViaImageOption) String() string

type SortOrderEnum 

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for SortOrderEnum

func GetSortOrderEnumValues 

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type UpdateClusterDetails 

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

UpdateClusterDetails The properties that define a request to update a cluster.

func (UpdateClusterDetails) String 

func (m UpdateClusterDetails) String() string

type UpdateClusterOptionsDetails 

type UpdateClusterOptionsDetails struct {

	// Configurable cluster admission controllers
	AdmissionControllerOptions *AdmissionControllerOptions `mandatory:"false" json:"admissionControllerOptions"`
}

UpdateClusterOptionsDetails The properties that define extra options updating a cluster.

func (UpdateClusterOptionsDetails) String 

func (m UpdateClusterOptionsDetails) String() string

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

UpdateClusterRequest wrapper for the UpdateCluster operation

func (UpdateClusterRequest) HTTPRequest 

func (request UpdateClusterRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateClusterRequest) RetryPolicy 

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

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

func (UpdateClusterRequest) String 

func (request UpdateClusterRequest) String() string

type UpdateClusterResponse 

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

UpdateClusterResponse wrapper for the UpdateCluster operation

func (UpdateClusterResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateClusterResponse) String 

func (response UpdateClusterResponse) String() string

type UpdateNodePoolDetails 

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

UpdateNodePoolDetails The properties that define a request to update a node pool.

func (UpdateNodePoolDetails) String 

func (m UpdateNodePoolDetails) String() string

func (*UpdateNodePoolDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type UpdateNodePoolNodeConfigDetails 

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

UpdateNodePoolNodeConfigDetails The size and placement configuration of nodes in the node pool.

func (UpdateNodePoolNodeConfigDetails) String 

func (m UpdateNodePoolNodeConfigDetails) String() string

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

UpdateNodePoolRequest wrapper for the UpdateNodePool operation

func (UpdateNodePoolRequest) HTTPRequest 

func (request UpdateNodePoolRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateNodePoolRequest) RetryPolicy 

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

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

func (UpdateNodePoolRequest) String 

func (request UpdateNodePoolRequest) String() string

type UpdateNodePoolResponse 

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

UpdateNodePoolResponse wrapper for the UpdateNodePool operation

func (UpdateNodePoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateNodePoolResponse) String 

func (response UpdateNodePoolResponse) String() string

type UpdateNodeShapeConfigDetails 

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

UpdateNodeShapeConfigDetails The shape configuration of the nodes.

func (UpdateNodeShapeConfigDetails) String 

func (m UpdateNodeShapeConfigDetails) String() string

type WorkRequest 

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

WorkRequest An asynchronous work request.

func (WorkRequest) String 

func (m WorkRequest) String() string

type WorkRequestError 

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

WorkRequestError Errors related to a specific work request.

func (WorkRequestError) String 

func (m WorkRequestError) String() string

type WorkRequestLogEntry 

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

WorkRequestLogEntry Log entries related to a specific work request.

func (WorkRequestLogEntry) String 

func (m WorkRequestLogEntry) String() string

type WorkRequestOperationTypeEnum 

type WorkRequestOperationTypeEnum string

WorkRequestOperationTypeEnum Enum with underlying type: string 

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 

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

Set of constants representing the allowable values for WorkRequestOperationTypeEnum Deprecated

func GetWorkRequestOperationTypeEnumValues 

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource 

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

WorkRequestResource The properties that define a work request resource.

func (WorkRequestResource) String 

func (m WorkRequestResource) String() string

type WorkRequestResourceActionTypeEnum 

type WorkRequestResourceActionTypeEnum string

WorkRequestResourceActionTypeEnum Enum with underlying type: string 

const (
	WorkRequestResourceActionTypeCreated    WorkRequestResourceActionTypeEnum = "CREATED"
	WorkRequestResourceActionTypeUpdated    WorkRequestResourceActionTypeEnum = "UPDATED"
	WorkRequestResourceActionTypeDeleted    WorkRequestResourceActionTypeEnum = "DELETED"
	WorkRequestResourceActionTypeRelated    WorkRequestResourceActionTypeEnum = "RELATED"
	WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
	WorkRequestResourceActionTypeFailed     WorkRequestResourceActionTypeEnum = "FAILED"
)

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

func GetWorkRequestResourceActionTypeEnumValues 

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestStatusEnum 

type WorkRequestStatusEnum string

WorkRequestStatusEnum Enum with underlying type: string 

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 

const (
	WorkRequestSummaryStatusAccepted   WorkRequestStatusEnum = "ACCEPTED"
	WorkRequestSummaryStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
	WorkRequestSummaryStatusFailed     WorkRequestStatusEnum = "FAILED"
	WorkRequestSummaryStatusSucceeded  WorkRequestStatusEnum = "SUCCEEDED"
	WorkRequestSummaryStatusCanceling  WorkRequestStatusEnum = "CANCELING"
	WorkRequestSummaryStatusCanceled   WorkRequestStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestStatusEnum Deprecated

func GetWorkRequestStatusEnumValues 

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary 

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

WorkRequestSummary The properties that define a work request summary.

func (WorkRequestSummary) String 

func (m WorkRequestSummary) String() string

type WorkRequestSummaryOperationTypeEnum 

type WorkRequestSummaryOperationTypeEnum = WorkRequestOperationTypeEnum

WorkRequestSummaryOperationTypeEnum is an alias to type: WorkRequestOperationTypeEnum Consider using WorkRequestOperationTypeEnum instead Deprecated

type WorkRequestSummaryStatusEnum 

type WorkRequestSummaryStatusEnum = WorkRequestStatusEnum

WorkRequestSummaryStatusEnum is an alias to type: WorkRequestStatusEnum Consider using WorkRequestStatusEnum instead Deprecated

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.