func GetActionTypesEnumStringValues() []string
GetActionTypesEnumStringValues Enumerates the set of values in String for ActionTypesEnum
func GetCommitmentEnumStringValues() []string
GetCommitmentEnumStringValues Enumerates the set of values in String for CommitmentEnum
func GetDatastoreClusterTypesEnumStringValues() []string
GetDatastoreClusterTypesEnumStringValues Enumerates the set of values in String for DatastoreClusterTypesEnum
func GetDatastoreTypesEnumStringValues() []string
GetDatastoreTypesEnumStringValues Enumerates the set of values in String for DatastoreTypesEnum
func GetHcxLicenseStatusEnumStringValues() []string
GetHcxLicenseStatusEnumStringValues Enumerates the set of values in String for HcxLicenseStatusEnum
func GetHcxModesEnumStringValues() []string
GetHcxModesEnumStringValues Enumerates the set of values in String for HcxModesEnum
func GetLifecycleStatesEnumStringValues() []string
GetLifecycleStatesEnumStringValues Enumerates the set of values in String for LifecycleStatesEnum
func GetListClustersLifecycleStateEnumStringValues() []string
GetListClustersLifecycleStateEnumStringValues Enumerates the set of values in String for ListClustersLifecycleStateEnum
func GetListClustersSortByEnumStringValues() []string
GetListClustersSortByEnumStringValues Enumerates the set of values in String for ListClustersSortByEnum
func GetListClustersSortOrderEnumStringValues() []string
GetListClustersSortOrderEnumStringValues Enumerates the set of values in String for ListClustersSortOrderEnum
func GetListEsxiHostsLifecycleStateEnumStringValues() []string
GetListEsxiHostsLifecycleStateEnumStringValues Enumerates the set of values in String for ListEsxiHostsLifecycleStateEnum
func GetListEsxiHostsSortByEnumStringValues() []string
GetListEsxiHostsSortByEnumStringValues Enumerates the set of values in String for ListEsxiHostsSortByEnum
func GetListEsxiHostsSortOrderEnumStringValues() []string
GetListEsxiHostsSortOrderEnumStringValues Enumerates the set of values in String for ListEsxiHostsSortOrderEnum
func GetListSddcsLifecycleStateEnumStringValues() []string
GetListSddcsLifecycleStateEnumStringValues Enumerates the set of values in String for ListSddcsLifecycleStateEnum
func GetListSddcsSortByEnumStringValues() []string
GetListSddcsSortByEnumStringValues Enumerates the set of values in String for ListSddcsSortByEnum
func GetListSddcsSortOrderEnumStringValues() []string
GetListSddcsSortOrderEnumStringValues Enumerates the set of values in String for ListSddcsSortOrderEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypesEnumStringValues() []string
GetOperationTypesEnumStringValues Enumerates the set of values in String for OperationTypesEnum
func GetPasswordTypesEnumStringValues() []string
GetPasswordTypesEnumStringValues Enumerates the set of values in String for PasswordTypesEnum
func GetRetrievePasswordTypeEnumStringValues() []string
GetRetrievePasswordTypeEnumStringValues Enumerates the set of values in String for RetrievePasswordTypeEnum
func GetSortOrdersEnumStringValues() []string
GetSortOrdersEnumStringValues Enumerates the set of values in String for SortOrdersEnum
func GetVsphereTypesEnumStringValues() []string
GetVsphereTypesEnumStringValues Enumerates the set of values in String for VsphereTypesEnum
ActionTypesEnum Enum with underlying type: string
type ActionTypesEnum string
Set of constants representing the allowable values for ActionTypesEnum
const (
ActionTypesCreated ActionTypesEnum = "CREATED"
ActionTypesUpdated ActionTypesEnum = "UPDATED"
ActionTypesDeleted ActionTypesEnum = "DELETED"
ActionTypesInProgress ActionTypesEnum = "IN_PROGRESS"
ActionTypesRelated ActionTypesEnum = "RELATED"
ActionTypesFailed ActionTypesEnum = "FAILED"
)
func GetActionTypesEnumValues() []ActionTypesEnum
GetActionTypesEnumValues Enumerates the set of values for ActionTypesEnum
func GetMappingActionTypesEnum(val string) (ActionTypesEnum, bool)
GetMappingActionTypesEnum performs case Insensitive comparison on enum value and return the desired enum
CancelDowngradeHcxRequest wrapper for the CancelDowngradeHcx operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/CancelDowngradeHcx.go.html to see an example of how to use CancelDowngradeHcxRequest.
type CancelDowngradeHcxRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelDowngradeHcxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelDowngradeHcxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelDowngradeHcxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelDowngradeHcxRequest) String() string
func (request CancelDowngradeHcxRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelDowngradeHcxResponse wrapper for the CancelDowngradeHcx operation
type CancelDowngradeHcxResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelDowngradeHcxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelDowngradeHcxResponse) String() string
ChangeSddcCompartmentDetails The configuration details for the move operation.
type ChangeSddcCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move
// the SDDC to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeSddcCompartmentDetails) String() string
func (m ChangeSddcCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeSddcCompartmentRequest wrapper for the ChangeSddcCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ChangeSddcCompartment.go.html to see an example of how to use ChangeSddcCompartmentRequest.
type ChangeSddcCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"`
// Request to change the compartment of the specified SDDC
ChangeSddcCompartmentDetails `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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeSddcCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeSddcCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeSddcCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeSddcCompartmentRequest) String() string
func (request ChangeSddcCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeSddcCompartmentResponse wrapper for the ChangeSddcCompartment operation
type ChangeSddcCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeSddcCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeSddcCompartmentResponse) String() string
Cluster An Oracle Cloud VMware Solution (https://docs.oracle.com/iaas/Content/VMware/Concepts/ocvsoverview.htm) Cluster contains the resources required for a functional VMware environment. Instances in a Cluster (see EsxiHost) run in a virtual cloud network (VCN) and are preconfigured with VMware and storage. Use the vCenter utility to manage and deploy VMware virtual machines (VMs) in the Cluster. The Cluster uses a single management subnet for provisioning the Cluster. It also uses a set of VLANs for various components of the VMware environment (vSphere, vMotion, vSAN, and so on). See the Core Services API for information about VCN subnets and VLANs.
type Cluster struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cluster.
Id *string `mandatory:"true" json:"id"`
// The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is `multi-AD`.
// Example: `Uocm:PHX-AD-1`, `multi-AD`
ComputeAvailabilityDomain *string `mandatory:"true" json:"computeAvailabilityDomain"`
// A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits,
// whitespaces, dashes and underscores.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// In general, this is a specific version of bundled VMware software supported by
// Oracle Cloud VMware Solution (see
// ListSupportedVmwareSoftwareVersions).
// This attribute is not guaranteed to reflect the version of
// software currently installed on the ESXi hosts in the Cluster. The purpose
// of this attribute is to show the version of software that the Oracle
// Cloud VMware Solution will install on any new ESXi hosts that you *add to this
// Cluster in the future* with CreateEsxiHost.
// Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer
// version of bundled VMware software supported by the Oracle Cloud VMware Solution, you
// should use UpdateCluster to update the Cluster's
// `vmwareSoftwareVersion` with that new version.
VmwareSoftwareVersion *string `mandatory:"true" json:"vmwareSoftwareVersion"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that
// contains the Cluster.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC that the
// Cluster belongs to.
SddcId *string `mandatory:"true" json:"sddcId"`
// The number of ESXi hosts in the Cluster.
EsxiHostsCount *int `mandatory:"true" json:"esxiHostsCount"`
NetworkConfiguration *NetworkConfiguration `mandatory:"true" json:"networkConfiguration"`
// The date and time the Cluster was created, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The initial compute shape of the Cluster's ESXi hosts.
// ListSupportedHostShapes.
InitialHostShapeName *string `mandatory:"true" json:"initialHostShapeName"`
// vSphere Cluster types.
VsphereType VsphereTypesEnum `mandatory:"true" json:"vsphereType"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// A prefix used in the name of each ESXi host and Compute instance in the Cluster.
// If this isn't set, the Cluster's `displayName` is used as the prefix.
// For example, if the value is `MyCluster`, the ESXi hosts are named `MyCluster-1`,
// `MyCluster-2`, and so on.
InstanceDisplayNamePrefix *string `mandatory:"false" json:"instanceDisplayNamePrefix"`
// In general, this is a specific version of bundled ESXi software supported by
// Oracle Cloud VMware Solution (see
// ListSupportedVmwareSoftwareVersions).
// This attribute is not guaranteed to reflect the version of
// software currently installed on the ESXi hosts in the SDDC. The purpose
// of this attribute is to show the version of software that the Oracle
// Cloud VMware Solution will install on any new ESXi hosts that you *add to this
// SDDC in the future* with CreateEsxiHost
// unless a different version is configured on the ESXi host level.
// Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer
// version of bundled ESXi software supported by the Oracle Cloud VMware Solution, you
// should use UpdateCluster to update the Cluster's
// `esxiSoftwareVersion` with that new version.
EsxiSoftwareVersion *string `mandatory:"false" json:"esxiSoftwareVersion"`
// The billing option selected during Cluster creation.
// ListSupportedCommitments.
InitialCommitment CommitmentEnum `mandatory:"false" json:"initialCommitment,omitempty"`
// The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application
// workloads.
WorkloadNetworkCidr *string `mandatory:"false" json:"workloadNetworkCidr"`
// The date and time the Cluster was updated, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the Cluster.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The vSphere licenses to use when upgrading the Cluster.
UpgradeLicenses []VsphereLicense `mandatory:"false" json:"upgradeLicenses"`
// The links to binary objects needed to upgrade vSphere.
VsphereUpgradeObjects []VsphereUpgradeObject `mandatory:"false" json:"vsphereUpgradeObjects"`
// The initial OCPU count of the Cluster's ESXi hosts.
InitialHostOcpuCount *float32 `mandatory:"false" json:"initialHostOcpuCount"`
// Indicates whether shielded instance is enabled at the Cluster level.
IsShieldedInstanceEnabled *bool `mandatory:"false" json:"isShieldedInstanceEnabled"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.
CapacityReservationId *string `mandatory:"false" json:"capacityReservationId"`
// Datastores used for the Cluster.
Datastores []DatastoreDetails `mandatory:"false" json:"datastores"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Cluster) String() string
func (m Cluster) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ClusterClient a client for Cluster
type ClusterClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewClusterClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ClusterClient, err error)
NewClusterClientWithConfigurationProvider Creates a new default Cluster client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewClusterClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ClusterClient, err error)
NewClusterClientWithOboToken Creates a new default Cluster client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *ClusterClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ClusterClient) CreateCluster(ctx context.Context, request CreateClusterRequest) (response CreateClusterResponse, err error)
CreateCluster Create a vSphere Cluster in software-defined data center (SDDC). Use the WorkRequest operations to track the creation of the Cluster. **Important:** You must configure the Cluster's networking resources with the security rules detailed in Security Rules for Oracle Cloud VMware Solution SDDCs (https://docs.oracle.com/iaas/Content/VMware/Reference/ocvssecurityrules.htm). Otherwise, provisioning the SDDC will fail. The rules are based on the requirements set by VMware.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/CreateCluster.go.html to see an example of how to use CreateCluster API. A default retry strategy applies to this operation CreateCluster()
func (client ClusterClient) DeleteCluster(ctx context.Context, request DeleteClusterRequest) (response DeleteClusterResponse, err error)
DeleteCluster Deletes the specified Cluster, along with the other resources that were created with the Cluster. For example: the Compute instances, DNS records, and so on. Use the WorkRequest operations to track the deletion of the Cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/DeleteCluster.go.html to see an example of how to use DeleteCluster API. A default retry strategy applies to this operation DeleteCluster()
func (client ClusterClient) GetCluster(ctx context.Context, request GetClusterRequest) (response GetClusterResponse, err error)
GetCluster Gets the specified Cluster's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/GetCluster.go.html to see an example of how to use GetCluster API. A default retry strategy applies to this operation GetCluster()
func (client ClusterClient) ListClusters(ctx context.Context, request ListClustersRequest) (response ListClustersResponse, err error)
ListClusters Lists the Clusters in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListClusters.go.html to see an example of how to use ListClusters API. A default retry strategy applies to this operation ListClusters()
func (client *ClusterClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ClusterClient) UpdateCluster(ctx context.Context, request UpdateClusterRequest) (response UpdateClusterResponse, err error)
UpdateCluster Updates the specified Cluster. **Important:** Updating a Cluster affects only certain attributes in the `Cluster` object and does not affect the VMware environment currently running in the Cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/UpdateCluster.go.html to see an example of how to use UpdateCluster API. A default retry strategy applies to this operation UpdateCluster()
ClusterCollection A list of Clusters.
type ClusterCollection struct {
// A list of Clusters.
Items []ClusterSummary `mandatory:"true" json:"items"`
}
func (m ClusterCollection) String() string
func (m ClusterCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ClusterSummary A summary of the Cluster.
type ClusterSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that
// contains the Cluster.
Id *string `mandatory:"true" json:"id"`
// The availability domain that the Cluster's ESXi hosts are running in. For Multi-AD Cluster, it is `multi-AD`.
ComputeAvailabilityDomain *string `mandatory:"true" json:"computeAvailabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC that the
// Cluster belongs to.
SddcId *string `mandatory:"true" json:"sddcId"`
// A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits,
// whitespaces, dashes and underscores.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// In general, this is a specific version of bundled VMware software supported by
// Oracle Cloud VMware Solution (see
// ListSupportedVmwareSoftwareVersions).
// This attribute is not guaranteed to reflect the version of
// software currently installed on the ESXi hosts in the Cluster. The purpose
// of this attribute is to show the version of software that the Oracle
// Cloud VMware Solution will install on any new ESXi hosts that you *add to this
// Cluster in the future* with CreateEsxiHost.
// Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer
// version of bundled VMware software supported by the Oracle Cloud VMware Solution, you
// should use UpdateCluster to update the Cluster's
// `vmwareSoftwareVersion` with that new version.
VmwareSoftwareVersion *string `mandatory:"true" json:"vmwareSoftwareVersion"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that
// contains the Cluster.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The number of ESXi hosts in the Cluster.
EsxiHostsCount *int `mandatory:"true" json:"esxiHostsCount"`
// The initial compute shape of the Cluster's ESXi hosts.
// ListSupportedHostShapes.
InitialHostShapeName *string `mandatory:"true" json:"initialHostShapeName"`
// vSphere Cluster types.
VsphereType VsphereTypesEnum `mandatory:"true" json:"vsphereType"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// The date and time the Cluster was created, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the Cluster was updated, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the Cluster.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Indicates whether shielded instance is enabled at the Cluster level.
IsShieldedInstanceEnabled *bool `mandatory:"false" json:"isShieldedInstanceEnabled"`
// The initial OCPU count of the Cluster's ESXi hosts.
InitialHostOcpuCount *float32 `mandatory:"false" json:"initialHostOcpuCount"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ClusterSummary) String() string
func (m ClusterSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CommitmentEnum Enum with underlying type: string
type CommitmentEnum string
Set of constants representing the allowable values for CommitmentEnum
const (
CommitmentHour CommitmentEnum = "HOUR"
CommitmentMonth CommitmentEnum = "MONTH"
CommitmentOneYear CommitmentEnum = "ONE_YEAR"
CommitmentThreeYears CommitmentEnum = "THREE_YEARS"
)
func GetCommitmentEnumValues() []CommitmentEnum
GetCommitmentEnumValues Enumerates the set of values for CommitmentEnum
func GetMappingCommitmentEnum(val string) (CommitmentEnum, bool)
GetMappingCommitmentEnum performs case Insensitive comparison on enum value and return the desired enum
CreateClusterDetails Details of the Cluster.
type CreateClusterDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC that the
// Cluster belongs to.
SddcId *string `mandatory:"true" json:"sddcId"`
// The availability domain to create the Cluster's ESXi hosts in. For multi-AD Cluster deployment, set to `multi-AD`.
ComputeAvailabilityDomain *string `mandatory:"true" json:"computeAvailabilityDomain"`
// The number of ESXi hosts to create in the Cluster. You can add more hosts later
// (see CreateEsxiHost).
// **Note:** If you later delete EXSi hosts from a production Cluster to make SDDC
// total host count less than 3, you are still billed for the 3 minimum recommended
// ESXi hosts. Also, you cannot add more VMware workloads to the Cluster until the
// SDDC again has at least 3 ESXi hosts.
EsxiHostsCount *int `mandatory:"true" json:"esxiHostsCount"`
NetworkConfiguration *NetworkConfiguration `mandatory:"true" json:"networkConfiguration"`
// A descriptive name for the Cluster.
// Cluster name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A prefix used in the name of each ESXi host and Compute instance in the Cluster.
// If this isn't set, the Cluster's `displayName` is used as the prefix.
// For example, if the value is `myCluster`, the ESXi hosts are named `myCluster-1`,
// `myCluster-2`, and so on.
InstanceDisplayNamePrefix *string `mandatory:"false" json:"instanceDisplayNamePrefix"`
// The billing option selected during Cluster creation.
// ListSupportedCommitments.
InitialCommitment CommitmentEnum `mandatory:"false" json:"initialCommitment,omitempty"`
// The CIDR block for the IP addresses that VMware VMs in the Cluster use to run application
// workloads.
WorkloadNetworkCidr *string `mandatory:"false" json:"workloadNetworkCidr"`
// The initial compute shape of the Cluster's ESXi hosts.
// ListSupportedHostShapes.
InitialHostShapeName *string `mandatory:"false" json:"initialHostShapeName"`
// The initial OCPU count of the Cluster's ESXi hosts.
InitialHostOcpuCount *float32 `mandatory:"false" json:"initialHostOcpuCount"`
// Indicates whether shielded instance is enabled for this Cluster.
IsShieldedInstanceEnabled *bool `mandatory:"false" json:"isShieldedInstanceEnabled"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.
CapacityReservationId *string `mandatory:"false" json:"capacityReservationId"`
// A list of datastore info for the Cluster.
// This value is required only when `initialHostShapeName` is a standard shape.
Datastores []DatastoreInfo `mandatory:"false" json:"datastores"`
// The VMware software bundle to install on the ESXi hosts in the Cluster. To get a list of the available versions, use
// ListSupportedVmwareSoftwareVersions.
VmwareSoftwareVersion *string `mandatory:"false" json:"vmwareSoftwareVersion"`
// The ESXi software bundle to install on the ESXi hosts in the Cluster.
// Only versions under the same vmwareSoftwareVersion and have been validate by Oracle Cloud VMware Solution will be accepted.
// To get a list of the available versions, use
// ListSupportedVmwareSoftwareVersions.
EsxiSoftwareVersion *string `mandatory:"false" json:"esxiSoftwareVersion"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateClusterDetails) String() string
func (m CreateClusterDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateClusterRequest wrapper for the CreateCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/CreateCluster.go.html to see an example of how to use CreateClusterRequest.
type CreateClusterRequest struct {
// Details for the Cluster.
CreateClusterDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateClusterRequest) String() string
func (request CreateClusterRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateClusterResponse wrapper for the CreateCluster operation
type CreateClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateClusterResponse) String() string
CreateEsxiHostDetails Details of the ESXi host to add to the Cluster.
type CreateEsxiHostDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cluster to add the ESXi host to.
ClusterId *string `mandatory:"true" json:"clusterId"`
// A descriptive name for the ESXi host. It's changeable.
// Esxi Host name requirements are 1-16 character length limit, Must start with a letter,
// Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the Cluster.
// If this attribute is not specified, the Cluster's `instanceDisplayNamePrefix` attribute is used
// to name and incrementally number the ESXi host. For example, if you're creating the fourth
// ESXi host in the Cluster, and `instanceDisplayNamePrefix` is `MyCluster`, the host's display
// name is `MyCluster-4`.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deleted ESXi Host with LeftOver billing cycle.
BillingDonorHostId *string `mandatory:"false" json:"billingDonorHostId"`
// The billing option currently used by the ESXi host.
// ListSupportedCommitments.
CurrentCommitment CommitmentEnum `mandatory:"false" json:"currentCommitment,omitempty"`
// The billing option to switch to after the existing billing cycle ends.
// If `nextCommitment` is null or empty, `currentCommitment` continues to the next billing cycle.
// ListSupportedCommitments.
NextCommitment CommitmentEnum `mandatory:"false" json:"nextCommitment,omitempty"`
// The availability domain to create the ESXi host in.
// If keep empty, for AD-specific Cluster, new ESXi host will be created in the same availability domain;
// for multi-AD Cluster, new ESXi host will be auto assigned to the next availability domain following evenly distribution strategy.
ComputeAvailabilityDomain *string `mandatory:"false" json:"computeAvailabilityDomain"`
// The compute shape name of the ESXi host.
// ListSupportedHostShapes.
HostShapeName *string `mandatory:"false" json:"hostShapeName"`
// The OCPU count of the ESXi host.
HostOcpuCount *float32 `mandatory:"false" json:"hostOcpuCount"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.
CapacityReservationId *string `mandatory:"false" json:"capacityReservationId"`
// The ESXi software bundle to install on the ESXi host.
// Only versions under the same vmwareSoftwareVersion and have been validate by Oracle Cloud VMware Solution will be accepted.
// To get a list of the available versions, use
// ListSupportedVmwareSoftwareVersions.
EsxiSoftwareVersion *string `mandatory:"false" json:"esxiSoftwareVersion"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateEsxiHostDetails) String() string
func (m CreateEsxiHostDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateEsxiHostRequest wrapper for the CreateEsxiHost operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/CreateEsxiHost.go.html to see an example of how to use CreateEsxiHostRequest.
type CreateEsxiHostRequest struct {
// Details for the ESXi host.
CreateEsxiHostDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateEsxiHostRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateEsxiHostRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateEsxiHostRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateEsxiHostRequest) String() string
func (request CreateEsxiHostRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateEsxiHostResponse wrapper for the CreateEsxiHost operation
type CreateEsxiHostResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateEsxiHostResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateEsxiHostResponse) String() string
CreateSddcDetails Details of the SDDC.
type CreateSddcDetails struct {
// The VMware software bundle to install on the ESXi hosts in the SDDC. To get a
// list of the available versions, use
// ListSupportedVmwareSoftwareVersions.
VmwareSoftwareVersion *string `mandatory:"true" json:"vmwareSoftwareVersion"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the SDDC.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// HCX configuration of the SDDC.
HcxMode HcxModesEnum `mandatory:"true" json:"hcxMode"`
InitialConfiguration *InitialConfiguration `mandatory:"true" json:"initialConfiguration"`
// One or more public SSH keys to be included in the `~/.ssh/authorized_keys` file for
// the default user on each ESXi host. Use a newline character to separate multiple keys.
// The SSH keys must be in the format required for the `authorized_keys` file
SshAuthorizedKeys *string `mandatory:"true" json:"sshAuthorizedKeys"`
// A descriptive name for the SDDC.
// SDDC name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The ESXi software bundle to install on the ESXi hosts in the SDDC.
// Only versions under the same vmwareSoftwareVersion and have been validate by Oracle Cloud VMware Solution will be accepted.
// To get a list of the available versions, use
// ListSupportedVmwareSoftwareVersions.
EsxiSoftwareVersion *string `mandatory:"false" json:"esxiSoftwareVersion"`
// Indicates whether this SDDC is designated for only single ESXi host.
IsSingleHostSddc *bool `mandatory:"false" json:"isSingleHostSddc"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateSddcDetails) String() string
func (m CreateSddcDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSddcRequest wrapper for the CreateSddc operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/CreateSddc.go.html to see an example of how to use CreateSddcRequest.
type CreateSddcRequest struct {
// Details for the SDDC.
CreateSddcDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateSddcRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSddcRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSddcRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSddcRequest) String() string
func (request CreateSddcRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSddcResponse wrapper for the CreateSddc operation
type CreateSddcResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateSddcResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSddcResponse) String() string
DatastoreClusterTypesEnum Enum with underlying type: string
type DatastoreClusterTypesEnum string
Set of constants representing the allowable values for DatastoreClusterTypesEnum
const (
DatastoreClusterTypesManagement DatastoreClusterTypesEnum = "MANAGEMENT"
DatastoreClusterTypesWorkload DatastoreClusterTypesEnum = "WORKLOAD"
)
func GetDatastoreClusterTypesEnumValues() []DatastoreClusterTypesEnum
GetDatastoreClusterTypesEnumValues Enumerates the set of values for DatastoreClusterTypesEnum
func GetMappingDatastoreClusterTypesEnum(val string) (DatastoreClusterTypesEnum, bool)
GetMappingDatastoreClusterTypesEnum performs case Insensitive comparison on enum value and return the desired enum
DatastoreDetails Datastore details for a getting an Sddc.
type DatastoreDetails struct {
// A list of OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes.
BlockVolumeIds []string `mandatory:"true" json:"blockVolumeIds"`
// Type of the datastore.
DatastoreType DatastoreTypesEnum `mandatory:"true" json:"datastoreType"`
// Size of the Block Storage Volume in GB.
Capacity *float64 `mandatory:"true" json:"capacity"`
}
func (m DatastoreDetails) String() string
func (m DatastoreDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DatastoreInfo Datastore info for creating an Sddc.
type DatastoreInfo struct {
// A list of OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes.
BlockVolumeIds []string `mandatory:"true" json:"blockVolumeIds"`
// Type of the datastore.
DatastoreType DatastoreTypesEnum `mandatory:"true" json:"datastoreType"`
}
func (m DatastoreInfo) String() string
func (m DatastoreInfo) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DatastoreTypesEnum Enum with underlying type: string
type DatastoreTypesEnum string
Set of constants representing the allowable values for DatastoreTypesEnum
const (
DatastoreTypesManagement DatastoreTypesEnum = "MANAGEMENT"
DatastoreTypesWorkload DatastoreTypesEnum = "WORKLOAD"
)
func GetDatastoreTypesEnumValues() []DatastoreTypesEnum
GetDatastoreTypesEnumValues Enumerates the set of values for DatastoreTypesEnum
func GetMappingDatastoreTypesEnum(val string) (DatastoreTypesEnum, bool)
GetMappingDatastoreTypesEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteClusterRequest wrapper for the DeleteCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/DeleteCluster.go.html to see an example of how to use DeleteClusterRequest.
type DeleteClusterRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC 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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteClusterRequest) String() string
func (request DeleteClusterRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteClusterResponse wrapper for the DeleteCluster operation
type DeleteClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteClusterResponse) String() string
DeleteEsxiHostRequest wrapper for the DeleteEsxiHost operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/DeleteEsxiHost.go.html to see an example of how to use DeleteEsxiHostRequest.
type DeleteEsxiHostRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host.
EsxiHostId *string `mandatory:"true" contributesTo:"path" name:"esxiHostId"`
// 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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteEsxiHostRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteEsxiHostRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteEsxiHostRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteEsxiHostRequest) String() string
func (request DeleteEsxiHostRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteEsxiHostResponse wrapper for the DeleteEsxiHost operation
type DeleteEsxiHostResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteEsxiHostResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteEsxiHostResponse) String() string
DeleteSddcRequest wrapper for the DeleteSddc operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/DeleteSddc.go.html to see an example of how to use DeleteSddcRequest.
type DeleteSddcRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"`
// 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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteSddcRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSddcRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSddcRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSddcRequest) String() string
func (request DeleteSddcRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteSddcResponse wrapper for the DeleteSddc operation
type DeleteSddcResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteSddcResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSddcResponse) String() string
DowngradeHcxDetails The HCX on-premise license keys to be reserved when downgrading from HCX Enterprise to HCX Advanced. Downgrading from HCX Enterprise to HCX Advanced reduces the number of provided license keys from 10 to 3.
type DowngradeHcxDetails struct {
// The HCX on-premise license keys to be reserved when downgrading from HCX Enterprise to HCX Advanced.
ReservingHcxOnPremiseLicenseKeys []string `mandatory:"true" json:"reservingHcxOnPremiseLicenseKeys"`
}
func (m DowngradeHcxDetails) String() string
func (m DowngradeHcxDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DowngradeHcxRequest wrapper for the DowngradeHcx operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/DowngradeHcx.go.html to see an example of how to use DowngradeHcxRequest.
type DowngradeHcxRequest struct {
// The HCX on-premise license keys to be reserved when downgrading from HCX Enterprise to HCX Advanced.
DowngradeHcxDetails `contributesTo:"body"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DowngradeHcxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DowngradeHcxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DowngradeHcxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DowngradeHcxRequest) String() string
func (request DowngradeHcxRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DowngradeHcxResponse wrapper for the DowngradeHcx operation
type DowngradeHcxResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DowngradeHcxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DowngradeHcxResponse) String() string
EsxiHost An ESXi host is a node in a Cluster. At a minimum, each Cluster has 3 ESXi hosts that are used to implement a functioning VMware environment. In terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software. Notice that an `EsxiHost` object has its own OCID (`id`), and a separate attribute for the OCID of the Compute instance (`computeInstanceId`).
type EsxiHost struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host.
Id *string `mandatory:"true" json:"id"`
// A descriptive name for the ESXi host. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC that the
// ESXi host belongs to.
SddcId *string `mandatory:"true" json:"sddcId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cluster that the
// ESXi host belongs to.
ClusterId *string `mandatory:"true" json:"clusterId"`
// The billing option currently used by the ESXi host.
// ListSupportedCommitments.
CurrentCommitment CommitmentEnum `mandatory:"true" json:"currentCommitment"`
// The billing option to switch to after the current billing cycle ends.
// If `nextCommitment` is null or empty, `currentCommitment` continues to the next billing cycle.
// ListSupportedCommitments.
NextCommitment CommitmentEnum `mandatory:"true" json:"nextCommitment"`
// Current billing cycle end date. If the value in `currentCommitment` and `nextCommitment` are different, the value specified in `nextCommitment`
// becomes the new `currentCommitment` when the `contractEndDate` is reached.
// Example: `2016-08-25T21:10:29.600Z`
BillingContractEndDate *common.SDKTime `mandatory:"true" json:"billingContractEndDate"`
// The version of VMware software that Oracle Cloud VMware Solution installed on the ESXi hosts.
VmwareSoftwareVersion *string `mandatory:"true" json:"vmwareSoftwareVersion"`
// The availability domain of the ESXi host.
ComputeAvailabilityDomain *string `mandatory:"true" json:"computeAvailabilityDomain"`
// The compute shape name of the ESXi host.
// ListSupportedHostShapes.
HostShapeName *string `mandatory:"true" json:"hostShapeName"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that
// contains the Cluster.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// In terms of implementation, an ESXi host is a Compute instance that
// is configured with the chosen bundle of VMware software. The `computeInstanceId`
// is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of that Compute instance.
ComputeInstanceId *string `mandatory:"false" json:"computeInstanceId"`
// The date and time the ESXi host was created, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the ESXi host was updated, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the ESXi host.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deleted ESXi Host with LeftOver billing cycle.
BillingDonorHostId *string `mandatory:"false" json:"billingDonorHostId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the active ESXi Host to swap billing with current host.
SwapBillingHostId *string `mandatory:"false" json:"swapBillingHostId"`
// Indicates whether this host is in the progress of billing continuation.
IsBillingContinuationInProgress *bool `mandatory:"false" json:"isBillingContinuationInProgress"`
// Indicates whether this host is in the progress of swapping billing.
IsBillingSwappingInProgress *bool `mandatory:"false" json:"isBillingSwappingInProgress"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that failed.
FailedEsxiHostId *string `mandatory:"false" json:"failedEsxiHostId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that
// is created to replace the failed host.
ReplacementEsxiHostId *string `mandatory:"false" json:"replacementEsxiHostId"`
// The date and time when the new esxi host should start billing cycle.
// RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2021-07-25T21:10:29.600Z`
GracePeriodEndDate *common.SDKTime `mandatory:"false" json:"gracePeriodEndDate"`
// The version of ESXi software that Oracle Cloud VMware Solution installed on the ESXi hosts.
EsxiSoftwareVersion *string `mandatory:"false" json:"esxiSoftwareVersion"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that
// will be upgraded.
NonUpgradedEsxiHostId *string `mandatory:"false" json:"nonUpgradedEsxiHostId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that
// is newly created to upgrade the original host.
UpgradedReplacementEsxiHostId *string `mandatory:"false" json:"upgradedReplacementEsxiHostId"`
// The OCPU count of the ESXi host.
HostOcpuCount *float32 `mandatory:"false" json:"hostOcpuCount"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.
CapacityReservationId *string `mandatory:"false" json:"capacityReservationId"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m EsxiHost) String() string
func (m EsxiHost) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EsxiHostClient a client for EsxiHost
type EsxiHostClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewEsxiHostClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client EsxiHostClient, err error)
NewEsxiHostClientWithConfigurationProvider Creates a new default EsxiHost client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewEsxiHostClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client EsxiHostClient, err error)
NewEsxiHostClientWithOboToken Creates a new default EsxiHost client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *EsxiHostClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client EsxiHostClient) CreateEsxiHost(ctx context.Context, request CreateEsxiHostRequest) (response CreateEsxiHostResponse, err error)
CreateEsxiHost Adds another ESXi host to an existing SDDC. The attributes of the specified `Sddc` determine the VMware software and other configuration settings used by the ESXi host. Use the WorkRequest operations to track the creation of the ESXi host.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/CreateEsxiHost.go.html to see an example of how to use CreateEsxiHost API. A default retry strategy applies to this operation CreateEsxiHost()
func (client EsxiHostClient) DeleteEsxiHost(ctx context.Context, request DeleteEsxiHostRequest) (response DeleteEsxiHostResponse, err error)
DeleteEsxiHost Deletes the specified ESXi host. Before deleting the host, back up or migrate any VMware workloads running on it. When you delete an ESXi host, Oracle does not remove the node configuration within the VMware environment itself. That is your responsibility. **Note:** If you delete EXSi hosts from the SDDC to total less than 3, you are still billed for the 3 minimum recommended EXSi hosts. Also, you cannot add more VMware workloads to the SDDC until it again has at least 3 ESXi hosts. Use the WorkRequest operations to track the deletion of the ESXi host.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/DeleteEsxiHost.go.html to see an example of how to use DeleteEsxiHost API. A default retry strategy applies to this operation DeleteEsxiHost()
func (client EsxiHostClient) GetEsxiHost(ctx context.Context, request GetEsxiHostRequest) (response GetEsxiHostResponse, err error)
GetEsxiHost Gets the specified ESXi host's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/GetEsxiHost.go.html to see an example of how to use GetEsxiHost API. A default retry strategy applies to this operation GetEsxiHost()
func (client EsxiHostClient) InplaceUpgrade(ctx context.Context, request InplaceUpgradeRequest) (response InplaceUpgradeResponse, err error)
InplaceUpgrade In-place upgrade a ESXi host.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/InplaceUpgrade.go.html to see an example of how to use InplaceUpgrade API. A default retry strategy applies to this operation InplaceUpgrade()
func (client EsxiHostClient) ListEsxiHosts(ctx context.Context, request ListEsxiHostsRequest) (response ListEsxiHostsResponse, err error)
ListEsxiHosts Lists the ESXi hosts in the specified SDDC. The list can be filtered by Compute instance OCID or ESXi display name. Remember that in terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software. Each `EsxiHost` object has its own OCID (`id`), and a separate attribute for the OCID of the Compute instance (`computeInstanceId`). When filtering the list of ESXi hosts, you can specify the OCID of the Compute instance, not the ESXi host OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListEsxiHosts.go.html to see an example of how to use ListEsxiHosts API. A default retry strategy applies to this operation ListEsxiHosts()
func (client EsxiHostClient) ReplaceHost(ctx context.Context, request ReplaceHostRequest) (response ReplaceHostResponse, err error)
ReplaceHost Replace a faulty ESXi host whose underlying bare metal is broken
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ReplaceHost.go.html to see an example of how to use ReplaceHost API. A default retry strategy applies to this operation ReplaceHost()
func (client *EsxiHostClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client EsxiHostClient) SwapBilling(ctx context.Context, request SwapBillingRequest) (response SwapBillingResponse, err error)
SwapBilling Swap billing between two Active ESXi hosts.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/SwapBilling.go.html to see an example of how to use SwapBilling API. A default retry strategy applies to this operation SwapBilling()
func (client EsxiHostClient) UpdateEsxiHost(ctx context.Context, request UpdateEsxiHostRequest) (response UpdateEsxiHostResponse, err error)
UpdateEsxiHost Updates the specified ESXi host.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/UpdateEsxiHost.go.html to see an example of how to use UpdateEsxiHost API. A default retry strategy applies to this operation UpdateEsxiHost()
EsxiHostCollection A list of ESXi hosts.
type EsxiHostCollection struct {
// A list of ESXi hosts.
Items []EsxiHostSummary `mandatory:"true" json:"items"`
}
func (m EsxiHostCollection) String() string
func (m EsxiHostCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EsxiHostSummary A summary of the ESXi host.
type EsxiHostSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC that the
// ESXi host belongs to.
SddcId *string `mandatory:"true" json:"sddcId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cluster that the
// ESXi host belongs to.
ClusterId *string `mandatory:"true" json:"clusterId"`
// The billing option currently used by the ESXi host.
// ListSupportedCommitments.
CurrentCommitment CommitmentEnum `mandatory:"true" json:"currentCommitment"`
// The billing option to switch to after the current billing cycle ends.
// If `nextCommitment` is null or empty, `currentCommitment` continues to the next billing cycle.
// ListSupportedCommitments.
NextCommitment CommitmentEnum `mandatory:"true" json:"nextCommitment"`
// Current billing cycle end date. If the value in `currentCommitment` and `nextCommitment` are different, the value specified in `nextCommitment`
// becomes the new `currentCommitment` when the `contractEndDate` is reached.
// Example: `2016-08-25T21:10:29.600Z`
BillingContractEndDate *common.SDKTime `mandatory:"true" json:"billingContractEndDate"`
// The version of VMware software that Oracle Cloud VMware Solution installed on the ESXi hosts.
VmwareSoftwareVersion *string `mandatory:"true" json:"vmwareSoftwareVersion"`
// The availability domain of the ESXi host.
ComputeAvailabilityDomain *string `mandatory:"true" json:"computeAvailabilityDomain"`
// The compute shape name of the ESXi host.
// ListSupportedHostShapes.
HostShapeName *string `mandatory:"true" json:"hostShapeName"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// A descriptive name for the ESXi host. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that
// contains the Cluster.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// In terms of implementation, an ESXi host is a Compute instance that
// is configured with the chosen bundle of VMware software. The `computeInstanceId`
// is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of that Compute instance.
ComputeInstanceId *string `mandatory:"false" json:"computeInstanceId"`
// The date and time the ESXi host was created, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the ESXi host was updated, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the ESXi host.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that failed.
FailedEsxiHostId *string `mandatory:"false" json:"failedEsxiHostId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that
// is newly created to replace the failed host.
ReplacementEsxiHostId *string `mandatory:"false" json:"replacementEsxiHostId"`
// The date and time when the new esxi host should start billing cycle.
// RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2021-07-25T21:10:29.600Z`
GracePeriodEndDate *common.SDKTime `mandatory:"false" json:"gracePeriodEndDate"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that
// will be upgraded.
NonUpgradedEsxiHostId *string `mandatory:"false" json:"nonUpgradedEsxiHostId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that
// is newly created to upgrade the original host.
UpgradedReplacementEsxiHostId *string `mandatory:"false" json:"upgradedReplacementEsxiHostId"`
// The OCPU count of the ESXi host.
HostOcpuCount *float32 `mandatory:"false" json:"hostOcpuCount"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deleted ESXi Host with LeftOver billing cycle.
BillingDonorHostId *string `mandatory:"false" json:"billingDonorHostId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the active ESXi Host to swap billing with current host.
SwapBillingHostId *string `mandatory:"false" json:"swapBillingHostId"`
// Indicates whether this host is in the progress of billing continuation.
IsBillingContinuationInProgress *bool `mandatory:"false" json:"isBillingContinuationInProgress"`
// Indicates whether this host is in the progress of swapping billing.
IsBillingSwappingInProgress *bool `mandatory:"false" json:"isBillingSwappingInProgress"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m EsxiHostSummary) String() string
func (m EsxiHostSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetClusterRequest wrapper for the GetCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/GetCluster.go.html to see an example of how to use GetClusterRequest.
type GetClusterRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC Cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetClusterRequest) String() string
func (request GetClusterRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetClusterResponse wrapper for the GetCluster operation
type GetClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The Cluster instance
Cluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetClusterResponse) String() string
GetEsxiHostRequest wrapper for the GetEsxiHost operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/GetEsxiHost.go.html to see an example of how to use GetEsxiHostRequest.
type GetEsxiHostRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host.
EsxiHostId *string `mandatory:"true" contributesTo:"path" name:"esxiHostId"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetEsxiHostRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetEsxiHostRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetEsxiHostRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetEsxiHostRequest) String() string
func (request GetEsxiHostRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetEsxiHostResponse wrapper for the GetEsxiHost operation
type GetEsxiHostResponse struct {
// The underlying http response
RawResponse *http.Response
// The EsxiHost instance
EsxiHost `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetEsxiHostResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetEsxiHostResponse) String() string
GetSddcRequest wrapper for the GetSddc operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/GetSddc.go.html to see an example of how to use GetSddcRequest.
type GetSddcRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetSddcRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSddcRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSddcRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSddcRequest) String() string
func (request GetSddcRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSddcResponse wrapper for the GetSddc operation
type GetSddcResponse struct {
// The underlying http response
RawResponse *http.Response
// The Sddc instance
Sddc `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetSddcResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSddcResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HcxLicenseStatusEnum Enum with underlying type: string
type HcxLicenseStatusEnum string
Set of constants representing the allowable values for HcxLicenseStatusEnum
const (
HcxLicenseStatusAvailable HcxLicenseStatusEnum = "AVAILABLE"
HcxLicenseStatusConsumed HcxLicenseStatusEnum = "CONSUMED"
HcxLicenseStatusDeactivated HcxLicenseStatusEnum = "DEACTIVATED"
HcxLicenseStatusDeleted HcxLicenseStatusEnum = "DELETED"
)
func GetHcxLicenseStatusEnumValues() []HcxLicenseStatusEnum
GetHcxLicenseStatusEnumValues Enumerates the set of values for HcxLicenseStatusEnum
func GetMappingHcxLicenseStatusEnum(val string) (HcxLicenseStatusEnum, bool)
GetMappingHcxLicenseStatusEnum performs case Insensitive comparison on enum value and return the desired enum
HcxLicenseSummary HCX on-premise license information summary.
type HcxLicenseSummary struct {
// HCX on-premise license key value.
ActivationKey *string `mandatory:"true" json:"activationKey"`
// status of HCX on-premise license.
Status HcxLicenseStatusEnum `mandatory:"true" json:"status"`
// Name of the system that consumed the HCX on-premise license
SystemName *string `mandatory:"false" json:"systemName"`
}
func (m HcxLicenseSummary) String() string
func (m HcxLicenseSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HcxModesEnum Enum with underlying type: string
type HcxModesEnum string
Set of constants representing the allowable values for HcxModesEnum
const (
HcxModesDisabled HcxModesEnum = "DISABLED"
HcxModesAdvanced HcxModesEnum = "ADVANCED"
HcxModesEnterprise HcxModesEnum = "ENTERPRISE"
)
func GetHcxModesEnumValues() []HcxModesEnum
GetHcxModesEnumValues Enumerates the set of values for HcxModesEnum
func GetMappingHcxModesEnum(val string) (HcxModesEnum, bool)
GetMappingHcxModesEnum performs case Insensitive comparison on enum value and return the desired enum
InitialClusterConfiguration Details of the initial Cluster of SDDC.
type InitialClusterConfiguration struct {
// vSphere Cluster types.
VsphereType VsphereTypesEnum `mandatory:"true" json:"vsphereType"`
// The availability domain to create the Cluster's ESXi hosts in. For multi-AD Cluster deployment, set to `multi-AD`.
ComputeAvailabilityDomain *string `mandatory:"true" json:"computeAvailabilityDomain"`
// The number of ESXi hosts to create in the Cluster. You can add more hosts later
// (see CreateEsxiHost). Creating
// a Cluster with a ESXi host count of 1 will be considered a single ESXi host Cluster.
// **Note:** If you later delete EXSi hosts from a production Cluster to total less
// than 3, you are still billed for the 3 minimum recommended ESXi hosts. Also,
// you cannot add more VMware workloads to the Cluster until it again has at least
// 3 ESXi hosts.
EsxiHostsCount *int `mandatory:"true" json:"esxiHostsCount"`
NetworkConfiguration *NetworkConfiguration `mandatory:"true" json:"networkConfiguration"`
// A descriptive name for the Cluster.
// Cluster name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A prefix used in the name of each ESXi host and Compute instance in the Cluster.
// If this isn't set, the Cluster's `displayName` is used as the prefix.
// For example, if the value is `myCluster`, the ESXi hosts are named `myCluster-1`,
// `myCluster-2`, and so on.
InstanceDisplayNamePrefix *string `mandatory:"false" json:"instanceDisplayNamePrefix"`
// The billing option selected during Cluster creation.
// ListSupportedCommitments.
InitialCommitment CommitmentEnum `mandatory:"false" json:"initialCommitment,omitempty"`
// The CIDR block for the IP addresses that VMware VMs in the Cluster use to run application
// workloads.
WorkloadNetworkCidr *string `mandatory:"false" json:"workloadNetworkCidr"`
// The initial compute shape of the Cluster's ESXi hosts.
// ListSupportedHostShapes.
InitialHostShapeName *string `mandatory:"false" json:"initialHostShapeName"`
// The initial OCPU count of the Cluster's ESXi hosts.
InitialHostOcpuCount *float32 `mandatory:"false" json:"initialHostOcpuCount"`
// Indicates whether shielded instance is enabled for this Cluster.
IsShieldedInstanceEnabled *bool `mandatory:"false" json:"isShieldedInstanceEnabled"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.
CapacityReservationId *string `mandatory:"false" json:"capacityReservationId"`
// A list of datastore info for the Cluster.
// This value is required only when `initialHostShapeName` is a standard shape.
Datastores []DatastoreInfo `mandatory:"false" json:"datastores"`
}
func (m InitialClusterConfiguration) String() string
func (m InitialClusterConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InitialConfiguration Details of SDDC initial configuration
type InitialConfiguration struct {
// The configurations for Clusters initially created in the SDDC.
InitialClusterConfigurations []InitialClusterConfiguration `mandatory:"true" json:"initialClusterConfigurations"`
}
func (m InitialConfiguration) String() string
func (m InitialConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InplaceUpgradeRequest wrapper for the InplaceUpgrade operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/InplaceUpgrade.go.html to see an example of how to use InplaceUpgradeRequest.
type InplaceUpgradeRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host.
EsxiHostId *string `mandatory:"true" contributesTo:"path" name:"esxiHostId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request InplaceUpgradeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request InplaceUpgradeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request InplaceUpgradeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request InplaceUpgradeRequest) String() string
func (request InplaceUpgradeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InplaceUpgradeResponse wrapper for the InplaceUpgrade operation
type InplaceUpgradeResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response InplaceUpgradeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response InplaceUpgradeResponse) String() string
LifecycleStatesEnum Enum with underlying type: string
type LifecycleStatesEnum string
Set of constants representing the allowable values for LifecycleStatesEnum
const (
LifecycleStatesCreating LifecycleStatesEnum = "CREATING"
LifecycleStatesUpdating LifecycleStatesEnum = "UPDATING"
LifecycleStatesActive LifecycleStatesEnum = "ACTIVE"
LifecycleStatesDeleting LifecycleStatesEnum = "DELETING"
LifecycleStatesDeleted LifecycleStatesEnum = "DELETED"
LifecycleStatesFailed LifecycleStatesEnum = "FAILED"
)
func GetLifecycleStatesEnumValues() []LifecycleStatesEnum
GetLifecycleStatesEnumValues Enumerates the set of values for LifecycleStatesEnum
func GetMappingLifecycleStatesEnum(val string) (LifecycleStatesEnum, bool)
GetMappingLifecycleStatesEnum performs case Insensitive comparison on enum value and return the desired enum
ListClustersLifecycleStateEnum Enum with underlying type: string
type ListClustersLifecycleStateEnum string
Set of constants representing the allowable values for ListClustersLifecycleStateEnum
const (
ListClustersLifecycleStateCreating ListClustersLifecycleStateEnum = "CREATING"
ListClustersLifecycleStateUpdating ListClustersLifecycleStateEnum = "UPDATING"
ListClustersLifecycleStateActive ListClustersLifecycleStateEnum = "ACTIVE"
ListClustersLifecycleStateDeleting ListClustersLifecycleStateEnum = "DELETING"
ListClustersLifecycleStateDeleted ListClustersLifecycleStateEnum = "DELETED"
ListClustersLifecycleStateFailed ListClustersLifecycleStateEnum = "FAILED"
)
func GetListClustersLifecycleStateEnumValues() []ListClustersLifecycleStateEnum
GetListClustersLifecycleStateEnumValues Enumerates the set of values for ListClustersLifecycleStateEnum
func GetMappingListClustersLifecycleStateEnum(val string) (ListClustersLifecycleStateEnum, bool)
GetMappingListClustersLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListClustersRequest wrapper for the ListClusters operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListClusters.go.html to see an example of how to use ListClustersRequest.
type ListClustersRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
SddcId *string `mandatory:"false" contributesTo:"query" name:"sddcId"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order
// is case sensitive.
SortOrder ListClustersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
// sort order is case sensitive.
// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
// optionally filter by availability domain if the scope of the resource type is within a
// single availability domain. If you call one of these "List" operations without specifying
// an availability domain, the resources are grouped by availability domain, then sorted.
SortBy ListClustersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique 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 lifecycle state of the resource.
LifecycleState ListClustersLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment as optional parameter.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListClustersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListClustersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListClustersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListClustersRequest) String() string
func (request ListClustersRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListClustersResponse wrapper for the ListClusters operation
type ListClustersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ClusterCollection instances
ClusterCollection `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"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListClustersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListClustersResponse) String() string
ListClustersSortByEnum Enum with underlying type: string
type ListClustersSortByEnum string
Set of constants representing the allowable values for ListClustersSortByEnum
const (
ListClustersSortByTimecreated ListClustersSortByEnum = "timeCreated"
ListClustersSortByDisplayname ListClustersSortByEnum = "displayName"
)
func GetListClustersSortByEnumValues() []ListClustersSortByEnum
GetListClustersSortByEnumValues Enumerates the set of values for ListClustersSortByEnum
func GetMappingListClustersSortByEnum(val string) (ListClustersSortByEnum, bool)
GetMappingListClustersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListClustersSortOrderEnum Enum with underlying type: string
type ListClustersSortOrderEnum string
Set of constants representing the allowable values for ListClustersSortOrderEnum
const (
ListClustersSortOrderAsc ListClustersSortOrderEnum = "ASC"
ListClustersSortOrderDesc ListClustersSortOrderEnum = "DESC"
)
func GetListClustersSortOrderEnumValues() []ListClustersSortOrderEnum
GetListClustersSortOrderEnumValues Enumerates the set of values for ListClustersSortOrderEnum
func GetMappingListClustersSortOrderEnum(val string) (ListClustersSortOrderEnum, bool)
GetMappingListClustersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListEsxiHostsLifecycleStateEnum Enum with underlying type: string
type ListEsxiHostsLifecycleStateEnum string
Set of constants representing the allowable values for ListEsxiHostsLifecycleStateEnum
const (
ListEsxiHostsLifecycleStateCreating ListEsxiHostsLifecycleStateEnum = "CREATING"
ListEsxiHostsLifecycleStateUpdating ListEsxiHostsLifecycleStateEnum = "UPDATING"
ListEsxiHostsLifecycleStateActive ListEsxiHostsLifecycleStateEnum = "ACTIVE"
ListEsxiHostsLifecycleStateDeleting ListEsxiHostsLifecycleStateEnum = "DELETING"
ListEsxiHostsLifecycleStateDeleted ListEsxiHostsLifecycleStateEnum = "DELETED"
ListEsxiHostsLifecycleStateFailed ListEsxiHostsLifecycleStateEnum = "FAILED"
)
func GetListEsxiHostsLifecycleStateEnumValues() []ListEsxiHostsLifecycleStateEnum
GetListEsxiHostsLifecycleStateEnumValues Enumerates the set of values for ListEsxiHostsLifecycleStateEnum
func GetMappingListEsxiHostsLifecycleStateEnum(val string) (ListEsxiHostsLifecycleStateEnum, bool)
GetMappingListEsxiHostsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListEsxiHostsRequest wrapper for the ListEsxiHosts operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListEsxiHosts.go.html to see an example of how to use ListEsxiHostsRequest.
type ListEsxiHostsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
SddcId *string `mandatory:"false" contributesTo:"query" name:"sddcId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC Cluster.
ClusterId *string `mandatory:"false" contributesTo:"query" name:"clusterId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Compute instance.
ComputeInstanceId *string `mandatory:"false" contributesTo:"query" name:"computeInstanceId"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order
// is case sensitive.
SortOrder ListEsxiHostsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
// sort order is case sensitive.
// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
// optionally filter by availability domain if the scope of the resource type is within a
// single availability domain. If you call one of these "List" operations without specifying
// an availability domain, the resources are grouped by availability domain, then sorted.
SortBy ListEsxiHostsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique 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 lifecycle state of the resource.
LifecycleState ListEsxiHostsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// If this flag/param is set to True, we return only deleted hosts with LeftOver billingCycle.
IsBillingDonorsOnly *bool `mandatory:"false" contributesTo:"query" name:"isBillingDonorsOnly"`
// If this flag/param is set to True, we return only active hosts.
IsSwapBillingOnly *bool `mandatory:"false" contributesTo:"query" name:"isSwapBillingOnly"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment as optional parameter.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListEsxiHostsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListEsxiHostsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListEsxiHostsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListEsxiHostsRequest) String() string
func (request ListEsxiHostsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListEsxiHostsResponse wrapper for the ListEsxiHosts operation
type ListEsxiHostsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EsxiHostCollection instances
EsxiHostCollection `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"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListEsxiHostsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListEsxiHostsResponse) String() string
ListEsxiHostsSortByEnum Enum with underlying type: string
type ListEsxiHostsSortByEnum string
Set of constants representing the allowable values for ListEsxiHostsSortByEnum
const (
ListEsxiHostsSortByTimecreated ListEsxiHostsSortByEnum = "timeCreated"
ListEsxiHostsSortByDisplayname ListEsxiHostsSortByEnum = "displayName"
)
func GetListEsxiHostsSortByEnumValues() []ListEsxiHostsSortByEnum
GetListEsxiHostsSortByEnumValues Enumerates the set of values for ListEsxiHostsSortByEnum
func GetMappingListEsxiHostsSortByEnum(val string) (ListEsxiHostsSortByEnum, bool)
GetMappingListEsxiHostsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListEsxiHostsSortOrderEnum Enum with underlying type: string
type ListEsxiHostsSortOrderEnum string
Set of constants representing the allowable values for ListEsxiHostsSortOrderEnum
const (
ListEsxiHostsSortOrderAsc ListEsxiHostsSortOrderEnum = "ASC"
ListEsxiHostsSortOrderDesc ListEsxiHostsSortOrderEnum = "DESC"
)
func GetListEsxiHostsSortOrderEnumValues() []ListEsxiHostsSortOrderEnum
GetListEsxiHostsSortOrderEnumValues Enumerates the set of values for ListEsxiHostsSortOrderEnum
func GetMappingListEsxiHostsSortOrderEnum(val string) (ListEsxiHostsSortOrderEnum, bool)
GetMappingListEsxiHostsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSddcsLifecycleStateEnum Enum with underlying type: string
type ListSddcsLifecycleStateEnum string
Set of constants representing the allowable values for ListSddcsLifecycleStateEnum
const (
ListSddcsLifecycleStateCreating ListSddcsLifecycleStateEnum = "CREATING"
ListSddcsLifecycleStateUpdating ListSddcsLifecycleStateEnum = "UPDATING"
ListSddcsLifecycleStateActive ListSddcsLifecycleStateEnum = "ACTIVE"
ListSddcsLifecycleStateDeleting ListSddcsLifecycleStateEnum = "DELETING"
ListSddcsLifecycleStateDeleted ListSddcsLifecycleStateEnum = "DELETED"
ListSddcsLifecycleStateFailed ListSddcsLifecycleStateEnum = "FAILED"
)
func GetListSddcsLifecycleStateEnumValues() []ListSddcsLifecycleStateEnum
GetListSddcsLifecycleStateEnumValues Enumerates the set of values for ListSddcsLifecycleStateEnum
func GetMappingListSddcsLifecycleStateEnum(val string) (ListSddcsLifecycleStateEnum, bool)
GetMappingListSddcsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListSddcsRequest wrapper for the ListSddcs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListSddcs.go.html to see an example of how to use ListSddcsRequest.
type ListSddcsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the availability domain that the Compute instances are running in.
// Example: `Uocm:PHX-AD-1`
ComputeAvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"computeAvailabilityDomain"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order
// is case sensitive.
SortOrder ListSddcsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
// sort order is case sensitive.
// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
// optionally filter by availability domain if the scope of the resource type is within a
// single availability domain. If you call one of these "List" operations without specifying
// an availability domain, the resources are grouped by availability domain, then sorted.
SortBy ListSddcsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique 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 lifecycle state of the resource.
LifecycleState ListSddcsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSddcsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSddcsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSddcsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSddcsRequest) String() string
func (request ListSddcsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSddcsResponse wrapper for the ListSddcs operation
type ListSddcsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SddcCollection instances
SddcCollection `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"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListSddcsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSddcsResponse) String() string
ListSddcsSortByEnum Enum with underlying type: string
type ListSddcsSortByEnum string
Set of constants representing the allowable values for ListSddcsSortByEnum
const (
ListSddcsSortByTimecreated ListSddcsSortByEnum = "timeCreated"
ListSddcsSortByDisplayname ListSddcsSortByEnum = "displayName"
)
func GetListSddcsSortByEnumValues() []ListSddcsSortByEnum
GetListSddcsSortByEnumValues Enumerates the set of values for ListSddcsSortByEnum
func GetMappingListSddcsSortByEnum(val string) (ListSddcsSortByEnum, bool)
GetMappingListSddcsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSddcsSortOrderEnum Enum with underlying type: string
type ListSddcsSortOrderEnum string
Set of constants representing the allowable values for ListSddcsSortOrderEnum
const (
ListSddcsSortOrderAsc ListSddcsSortOrderEnum = "ASC"
ListSddcsSortOrderDesc ListSddcsSortOrderEnum = "DESC"
)
func GetListSddcsSortOrderEnumValues() []ListSddcsSortOrderEnum
GetListSddcsSortOrderEnumValues Enumerates the set of values for ListSddcsSortOrderEnum
func GetMappingListSddcsSortOrderEnum(val string) (ListSddcsSortOrderEnum, bool)
GetMappingListSddcsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSupportedCommitmentsRequest wrapper for the ListSupportedCommitments operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListSupportedCommitments.go.html to see an example of how to use ListSupportedCommitmentsRequest.
type ListSupportedCommitmentsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to return only resources that match or support the given ESXi host shape.
HostShapeName *string `mandatory:"false" contributesTo:"query" name:"hostShapeName"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSupportedCommitmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSupportedCommitmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSupportedCommitmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSupportedCommitmentsRequest) String() string
func (request ListSupportedCommitmentsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSupportedCommitmentsResponse wrapper for the ListSupportedCommitments operation
type ListSupportedCommitmentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SupportedCommitmentSummaryCollection instances
SupportedCommitmentSummaryCollection `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"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListSupportedCommitmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSupportedCommitmentsResponse) String() string
ListSupportedHostShapesRequest wrapper for the ListSupportedHostShapes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListSupportedHostShapes.go.html to see an example of how to use ListSupportedHostShapesRequest.
type ListSupportedHostShapesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to return only resources that match the given name exactly.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// A filter to return only resources that support single host SDDC.
IsSingleHostSddcSupported *bool `mandatory:"false" contributesTo:"query" name:"isSingleHostSddcSupported"`
// A filter to return only the shapes compatible with the initial host shape of the Cluster.
InitialHostShapeName *string `mandatory:"false" contributesTo:"query" name:"initialHostShapeName"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSupportedHostShapesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSupportedHostShapesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSupportedHostShapesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSupportedHostShapesRequest) String() string
func (request ListSupportedHostShapesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSupportedHostShapesResponse wrapper for the ListSupportedHostShapes operation
type ListSupportedHostShapesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SupportedHostShapeCollection instances
SupportedHostShapeCollection `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"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListSupportedHostShapesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSupportedHostShapesResponse) String() string
ListSupportedVmwareSoftwareVersionsRequest wrapper for the ListSupportedVmwareSoftwareVersions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListSupportedVmwareSoftwareVersions.go.html to see an example of how to use ListSupportedVmwareSoftwareVersionsRequest.
type ListSupportedVmwareSoftwareVersionsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to return only resources that match the given VMware software version exactly.
Version *string `mandatory:"false" contributesTo:"query" name:"version"`
// A filter to return only resources that match or support the given ESXi host shape.
HostShapeName *string `mandatory:"false" contributesTo:"query" name:"hostShapeName"`
// A filter to return only VMware software versions that the given VMware software version can be upgraded to.
VersionToUpgrade *string `mandatory:"false" contributesTo:"query" name:"versionToUpgrade"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSupportedVmwareSoftwareVersionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSupportedVmwareSoftwareVersionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSupportedVmwareSoftwareVersionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSupportedVmwareSoftwareVersionsRequest) String() string
func (request ListSupportedVmwareSoftwareVersionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSupportedVmwareSoftwareVersionsResponse wrapper for the ListSupportedVmwareSoftwareVersions operation
type ListSupportedVmwareSoftwareVersionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SupportedVmwareSoftwareVersionCollection instances
SupportedVmwareSoftwareVersionCollection `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"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListSupportedVmwareSoftwareVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSupportedVmwareSoftwareVersionsResponse) String() string
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// Unique identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestCollection instances
WorkRequestCollection `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"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
NetworkConfiguration The network configurations used by Cluster, including OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet and VLANs.
type NetworkConfiguration struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet used
// to provision the Cluster.
ProvisioningSubnetId *string `mandatory:"true" json:"provisioningSubnetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster
// for the vMotion component of the VMware environment.
// This attribute is not guaranteed to reflect the vMotion VLAN
// currently used by the ESXi hosts in the Cluster. The purpose
// of this attribute is to show the vMotion VLAN that the Oracle
// Cloud VMware Solution will use for any new ESXi hosts that you *add to this
// Cluster in the future* with CreateEsxiHost.
// Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN
// for the vMotion component of the VMware environment, you
// should use UpdateCluster to update the Cluster's
// `vmotionVlanId` with that new VLAN's OCID.
VmotionVlanId *string `mandatory:"true" json:"vmotionVlanId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster
// for the vSAN component of the VMware environment.
// This attribute is not guaranteed to reflect the vSAN VLAN
// currently used by the ESXi hosts in the Cluster. The purpose
// of this attribute is to show the vSAN VLAN that the Oracle
// Cloud VMware Solution will use for any new ESXi hosts that you *add to this
// Cluster in the future* with CreateEsxiHost.
// Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN
// for the vSAN component of the VMware environment, you
// should use UpdateCluster to update the Cluster's
// `vsanVlanId` with that new VLAN's OCID.
VsanVlanId *string `mandatory:"true" json:"vsanVlanId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster
// for the NSX VTEP component of the VMware environment.
// This attribute is not guaranteed to reflect the NSX VTEP VLAN
// currently used by the ESXi hosts in the Cluster. The purpose
// of this attribute is to show the NSX VTEP VLAN that the Oracle
// Cloud VMware Solution will use for any new ESXi hosts that you *add to this
// Cluster in the future* with CreateEsxiHost.
// Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN
// for the NSX VTEP component of the VMware environment, you
// should use UpdateCluster to update the Cluster's
// `nsxVTepVlanId` with that new VLAN's OCID.
NsxVTepVlanId *string `mandatory:"true" json:"nsxVTepVlanId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster
// for the NSX Edge VTEP component of the VMware environment.
// This attribute is not guaranteed to reflect the NSX Edge VTEP VLAN
// currently used by the ESXi hosts in the Cluster. The purpose
// of this attribute is to show the NSX Edge VTEP VLAN that the Oracle
// Cloud VMware Solution will use for any new ESXi hosts that you *add to this
// Cluster in the future* with CreateEsxiHost.
// Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN
// for the NSX Edge VTEP component of the VMware environment, you
// should use UpdateCluster to update the Cluster's
// `nsxEdgeVTepVlanId` with that new VLAN's OCID.
NsxEdgeVTepVlanId *string `mandatory:"true" json:"nsxEdgeVTepVlanId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC
// for the vSphere component of the VMware environment. This VLAN is a mandatory attribute
// for Management Cluster.
// This attribute is not guaranteed to reflect the vSphere VLAN
// currently used by the ESXi hosts in the Cluster. The purpose
// of this attribute is to show the vSphere VLAN that the Oracle
// Cloud VMware Solution will use for any new ESXi hosts that you *add to this
// Cluster in the future* with CreateEsxiHost.
// Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN
// for the vSphere component of the VMware environment, you
// should use UpdateSddc to update the Cluster's
// `vsphereVlanId` with that new VLAN's OCID.
VsphereVlanId *string `mandatory:"false" json:"vsphereVlanId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC
// for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory
// attribute for Management Cluster.
// This attribute is not guaranteed to reflect the NSX Edge Uplink 1 VLAN
// currently used by the ESXi hosts in the Cluster. The purpose
// of this attribute is to show the NSX Edge Uplink 1 VLAN that the Oracle
// Cloud VMware Solution will use for any new ESXi hosts that you *add to this
// Cluster in the future* with CreateEsxiHost.
// Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN
// for the NSX Edge Uplink 1 component of the VMware environment, you
// should use UpdateCluster to update the Cluster's
// `nsxEdgeUplink1VlanId` with that new VLAN's OCID.
NsxEdgeUplink1VlanId *string `mandatory:"false" json:"nsxEdgeUplink1VlanId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC
// for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory
// attribute for Management Cluster.
// This attribute is not guaranteed to reflect the NSX Edge Uplink 2 VLAN
// currently used by the ESXi hosts in the Cluster. The purpose
// of this attribute is to show the NSX Edge Uplink 2 VLAN that the Oracle
// Cloud VMware Solution will use for any new ESXi hosts that you *add to this
// Cluster in the future* with CreateEsxiHost.
// Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN
// for the NSX Edge Uplink 2 component of the VMware environment, you
// should use UpdateCluster to update the Cluster's
// `nsxEdgeUplink2VlanId` with that new VLAN's OCID.
NsxEdgeUplink2VlanId *string `mandatory:"false" json:"nsxEdgeUplink2VlanId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster
// for the vSphere Replication component of the VMware environment.
ReplicationVlanId *string `mandatory:"false" json:"replicationVlanId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster
// for the Provisioning component of the VMware environment.
ProvisioningVlanId *string `mandatory:"false" json:"provisioningVlanId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC
// for the HCX component of the VMware environment. This VLAN is a mandatory attribute
// for Management Cluster when HCX is enabled.
// This attribute is not guaranteed to reflect the HCX VLAN
// currently used by the ESXi hosts in the SDDC. The purpose
// of this attribute is to show the HCX VLAN that the Oracle
// Cloud VMware Solution will use for any new ESXi hosts that you *add to this
// SDDC in the future* with CreateEsxiHost.
// Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN
// for the HCX component of the VMware environment, you
// should use UpdateSddc to update the SDDC's
// `hcxVlanId` with that new VLAN's OCID.
HcxVlanId *string `mandatory:"false" json:"hcxVlanId"`
}
func (m NetworkConfiguration) String() string
func (m NetworkConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypesEnum Enum with underlying type: string
type OperationTypesEnum string
Set of constants representing the allowable values for OperationTypesEnum
const (
OperationTypesCreateSddc OperationTypesEnum = "CREATE_SDDC"
OperationTypesDeleteSddc OperationTypesEnum = "DELETE_SDDC"
OperationTypesCreateCluster OperationTypesEnum = "CREATE_CLUSTER"
OperationTypesDeleteCluster OperationTypesEnum = "DELETE_CLUSTER"
OperationTypesCreateEsxiHost OperationTypesEnum = "CREATE_ESXI_HOST"
OperationTypesDeleteEsxiHost OperationTypesEnum = "DELETE_ESXI_HOST"
OperationTypesUpgradeHcx OperationTypesEnum = "UPGRADE_HCX"
OperationTypesDowngradeHcx OperationTypesEnum = "DOWNGRADE_HCX"
OperationTypesCancelDowngradeHcx OperationTypesEnum = "CANCEL_DOWNGRADE_HCX"
OperationTypesRefreshHcxLicenseStatus OperationTypesEnum = "REFRESH_HCX_LICENSE_STATUS"
OperationTypesSwapBilling OperationTypesEnum = "SWAP_BILLING"
OperationTypesReplaceHost OperationTypesEnum = "REPLACE_HOST"
OperationTypesInPlaceUpgrade OperationTypesEnum = "IN_PLACE_UPGRADE"
OperationTypesCreateDatastore OperationTypesEnum = "CREATE_DATASTORE"
OperationTypesUpdateDatastore OperationTypesEnum = "UPDATE_DATASTORE"
OperationTypesAddBlockVolumeToDatastore OperationTypesEnum = "ADD_BLOCK_VOLUME_TO_DATASTORE"
OperationTypesDeleteDatastore OperationTypesEnum = "DELETE_DATASTORE"
OperationTypesCreateDatastoreCluster OperationTypesEnum = "CREATE_DATASTORE_CLUSTER"
OperationTypesUpdateDatastoreCluster OperationTypesEnum = "UPDATE_DATASTORE_CLUSTER"
OperationTypesAttachDatastoreClusterToEsxiHost OperationTypesEnum = "ATTACH_DATASTORE_CLUSTER_TO_ESXI_HOST"
OperationTypesAttachDatastoreClusterToCluster OperationTypesEnum = "ATTACH_DATASTORE_CLUSTER_TO_CLUSTER"
OperationTypesDetachDatastoreClusterFromEsxiHost OperationTypesEnum = "DETACH_DATASTORE_CLUSTER_FROM_ESXI_HOST"
OperationTypesDetachDatastoreClusterFromCluster OperationTypesEnum = "DETACH_DATASTORE_CLUSTER_FROM_CLUSTER"
OperationTypesDeleteDatastoreCluster OperationTypesEnum = "DELETE_DATASTORE_CLUSTER"
OperationTypesAddDatastoreToDatastoreCluster OperationTypesEnum = "ADD_DATASTORE_TO_DATASTORE_CLUSTER"
OperationTypesRemoveDatastoreFromDatastoreCluster OperationTypesEnum = "REMOVE_DATASTORE_FROM_DATASTORE_CLUSTER"
)
func GetMappingOperationTypesEnum(val string) (OperationTypesEnum, bool)
GetMappingOperationTypesEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypesEnumValues() []OperationTypesEnum
GetOperationTypesEnumValues Enumerates the set of values for OperationTypesEnum
PasswordTypesEnum Enum with underlying type: string
type PasswordTypesEnum string
Set of constants representing the allowable values for PasswordTypesEnum
const (
PasswordTypesVcenter PasswordTypesEnum = "VCENTER"
PasswordTypesNsx PasswordTypesEnum = "NSX"
PasswordTypesHcx PasswordTypesEnum = "HCX"
)
func GetMappingPasswordTypesEnum(val string) (PasswordTypesEnum, bool)
GetMappingPasswordTypesEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPasswordTypesEnumValues() []PasswordTypesEnum
GetPasswordTypesEnumValues Enumerates the set of values for PasswordTypesEnum
RefreshHcxLicenseStatusRequest wrapper for the RefreshHcxLicenseStatus operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/RefreshHcxLicenseStatus.go.html to see an example of how to use RefreshHcxLicenseStatusRequest.
type RefreshHcxLicenseStatusRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RefreshHcxLicenseStatusRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RefreshHcxLicenseStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RefreshHcxLicenseStatusRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RefreshHcxLicenseStatusRequest) String() string
func (request RefreshHcxLicenseStatusRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RefreshHcxLicenseStatusResponse wrapper for the RefreshHcxLicenseStatus operation
type RefreshHcxLicenseStatusResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RefreshHcxLicenseStatusResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RefreshHcxLicenseStatusResponse) String() string
ReplaceHostDetails The details for replacing ESXi host.
type ReplaceHostDetails struct {
// The ESXi software bundle to install on the ESXi host.
// Only versions under the same vmwareSoftwareVersion and have been validate by Oracle Cloud VMware Solution will be accepted.
// To get a list of the available versions, use
// ListSupportedVmwareSoftwareVersions.
EsxiSoftwareVersion *string `mandatory:"false" json:"esxiSoftwareVersion"`
}
func (m ReplaceHostDetails) String() string
func (m ReplaceHostDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ReplaceHostRequest wrapper for the ReplaceHost operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ReplaceHost.go.html to see an example of how to use ReplaceHostRequest.
type ReplaceHostRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host.
EsxiHostId *string `mandatory:"true" contributesTo:"path" name:"esxiHostId"`
// The details for replacing ESXi host
ReplaceHostDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ReplaceHostRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ReplaceHostRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ReplaceHostRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ReplaceHostRequest) String() string
func (request ReplaceHostRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ReplaceHostResponse wrapper for the ReplaceHost operation
type ReplaceHostResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ReplaceHostResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ReplaceHostResponse) String() string
RetrievePasswordRequest wrapper for the RetrievePassword operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/RetrievePassword.go.html to see an example of how to use RetrievePasswordRequest.
type RetrievePasswordRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"`
// The SDDC password type.
Type RetrievePasswordTypeEnum `mandatory:"true" contributesTo:"query" name:"type" omitEmpty:"true"`
// 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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RetrievePasswordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetrievePasswordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetrievePasswordRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetrievePasswordRequest) String() string
func (request RetrievePasswordRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RetrievePasswordResponse wrapper for the RetrievePassword operation
type RetrievePasswordResponse struct {
// The underlying http response
RawResponse *http.Response
// The SddcPassword instance
SddcPassword `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RetrievePasswordResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetrievePasswordResponse) String() string
RetrievePasswordTypeEnum Enum with underlying type: string
type RetrievePasswordTypeEnum string
Set of constants representing the allowable values for RetrievePasswordTypeEnum
const (
RetrievePasswordTypeVcenter RetrievePasswordTypeEnum = "VCENTER"
RetrievePasswordTypeNsx RetrievePasswordTypeEnum = "NSX"
RetrievePasswordTypeHcx RetrievePasswordTypeEnum = "HCX"
)
func GetMappingRetrievePasswordTypeEnum(val string) (RetrievePasswordTypeEnum, bool)
GetMappingRetrievePasswordTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRetrievePasswordTypeEnumValues() []RetrievePasswordTypeEnum
GetRetrievePasswordTypeEnumValues Enumerates the set of values for RetrievePasswordTypeEnum
Sddc An Oracle Cloud VMware Solution (https://docs.oracle.com/iaas/Content/VMware/Concepts/ocvsoverview.htm) software-defined data center (SDDC) contains the resources required for a functional VMware environment. Instances in an SDDC (see EsxiHost) run in a virtual cloud network (VCN) and are preconfigured with VMware and storage. Use the vCenter utility to manage and deploy VMware virtual machines (VMs) in the SDDC. The SDDC uses a single management subnet for provisioning the SDDC. It also uses a set of VLANs for various components of the VMware environment (vSphere, vMotion, vSAN, and so on). See the Core Services API for information about VCN subnets and VLANs.
type Sddc struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
Id *string `mandatory:"true" json:"id"`
// A descriptive name for the SDDC. It must be unique, start with a letter, and contain only letters, digits,
// whitespaces, dashes and underscores.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// In general, this is a specific version of bundled VMware software supported by
// Oracle Cloud VMware Solution (see
// ListSupportedVmwareSoftwareVersions).
// This attribute is not guaranteed to reflect the version of
// software currently installed on the ESXi hosts in the SDDC. The purpose
// of this attribute is to show the version of software that the Oracle
// Cloud VMware Solution will install on any new ESXi hosts that you *add to this
// SDDC in the future* with CreateEsxiHost.
// Therefore, if you upgrade the existing ESXi hosts in the SDDC to use a newer
// version of bundled VMware software supported by the Oracle Cloud VMware Solution, you
// should use UpdateSddc to update the SDDC's
// `vmwareSoftwareVersion` with that new version.
VmwareSoftwareVersion *string `mandatory:"true" json:"vmwareSoftwareVersion"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that
// contains the SDDC.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The number of Clusters in the SDDC.
ClustersCount *int `mandatory:"true" json:"clustersCount"`
// The FQDN for vCenter.
// Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com`
VcenterFqdn *string `mandatory:"true" json:"vcenterFqdn"`
// The FQDN for NSX Manager.
// Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com`
NsxManagerFqdn *string `mandatory:"true" json:"nsxManagerFqdn"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is
// the virtual IP (VIP) for vCenter. For information about `PrivateIp` objects, see the
// Core Services API.
VcenterPrivateIpId *string `mandatory:"true" json:"vcenterPrivateIpId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is
// the virtual IP (VIP) for NSX Manager. For information about `PrivateIp` objects, see the
// Core Services API.
NsxManagerPrivateIpId *string `mandatory:"true" json:"nsxManagerPrivateIpId"`
// One or more public SSH keys to be included in the `~/.ssh/authorized_keys` file for
// the default user on each ESXi host. Use a newline character to separate multiple keys.
// The SSH keys must be in the format required for the `authorized_keys` file.
// This attribute is not guaranteed to reflect the public SSH keys
// currently installed on the ESXi hosts in the SDDC. The purpose
// of this attribute is to show the public SSH keys that Oracle
// Cloud VMware Solution will install on any new ESXi hosts that you *add to this
// SDDC in the future* with CreateEsxiHost.
// Therefore, if you upgrade the existing ESXi hosts in the SDDC to use different
// SSH keys, you should use UpdateSddc to update
// the SDDC's `sshAuthorizedKeys` with the new public keys.
SshAuthorizedKeys *string `mandatory:"true" json:"sshAuthorizedKeys"`
// HCX configuration of the SDDC.
HcxMode HcxModesEnum `mandatory:"true" json:"hcxMode"`
InitialConfiguration *InitialConfiguration `mandatory:"true" json:"initialConfiguration"`
// The date and time the SDDC was created, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// In general, this is a specific version of bundled ESXi software supported by
// Oracle Cloud VMware Solution (see
// ListSupportedVmwareSoftwareVersions).
// This attribute is not guaranteed to reflect the version of
// software currently installed on the ESXi hosts in the SDDC. The purpose
// of this attribute is to show the version of software that the Oracle
// Cloud VMware Solution will install on any new ESXi hosts that you *add to this
// SDDC in the future* with CreateEsxiHost
// unless a different version is configured on the Cluster or ESXi host level.
// Therefore, if you upgrade the existing ESXi hosts in the SDDC to use a newer
// version of bundled ESXi software supported by the Oracle Cloud VMware Solution, you
// should use UpdateSddc to update the SDDC's
// `vmwareSoftwareVersion` with that new version.
EsxiSoftwareVersion *string `mandatory:"false" json:"esxiSoftwareVersion"`
// The SDDC includes an administrator username and password for vCenter. You can
// change this initial username to a different value in vCenter.
VcenterUsername *string `mandatory:"false" json:"vcenterUsername"`
// The SDDC includes an administrator username and initial password for NSX Manager. You
// can change this initial username to a different value in NSX Manager.
NsxManagerUsername *string `mandatory:"false" json:"nsxManagerUsername"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is
// the virtual IP (VIP) for the NSX Edge Uplink. Use this OCID as the route target for
// route table rules when setting up connectivity between the SDDC and other networks.
// For information about `PrivateIp` objects, see the Core Services API.
NsxEdgeUplinkIpId *string `mandatory:"false" json:"nsxEdgeUplinkIpId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is
// the virtual IP (VIP) for HCX Manager. For information about `PrivateIp` objects, see the
// Core Services API.
HcxPrivateIpId *string `mandatory:"false" json:"hcxPrivateIpId"`
// The FQDN for HCX Manager.
// Example: `hcx-my-sddc.sddc.us-phoenix-1.oraclecloud.com`
HcxFqdn *string `mandatory:"false" json:"hcxFqdn"`
// Indicates whether SDDC is pending downgrade from HCX Enterprise to HCX Advanced.
IsHcxPendingDowngrade *bool `mandatory:"false" json:"isHcxPendingDowngrade"`
// The activation licenses to use on the on-premises HCX Enterprise appliance you site pair with HCX Manager in your VMware Solution.
HcxOnPremLicenses []HcxLicenseSummary `mandatory:"false" json:"hcxOnPremLicenses"`
// The date and time current HCX Enterprise billing cycle ends, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeHcxBillingCycleEnd *common.SDKTime `mandatory:"false" json:"timeHcxBillingCycleEnd"`
// The date and time the SDDC's HCX on-premise license status was updated, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeHcxLicenseStatusUpdated *common.SDKTime `mandatory:"false" json:"timeHcxLicenseStatusUpdated"`
// Indicates whether this SDDC is designated for only single ESXi host.
IsSingleHostSddc *bool `mandatory:"false" json:"isSingleHostSddc"`
// The date and time the SDDC was updated, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the SDDC.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Sddc) String() string
func (m Sddc) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SddcClient a client for Sddc
type SddcClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewSddcClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SddcClient, err error)
NewSddcClientWithConfigurationProvider Creates a new default Sddc client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewSddcClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SddcClient, err error)
NewSddcClientWithOboToken Creates a new default Sddc client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client SddcClient) CancelDowngradeHcx(ctx context.Context, request CancelDowngradeHcxRequest) (response CancelDowngradeHcxResponse, err error)
CancelDowngradeHcx Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/CancelDowngradeHcx.go.html to see an example of how to use CancelDowngradeHcx API. A default retry strategy applies to this operation CancelDowngradeHcx()
func (client SddcClient) ChangeSddcCompartment(ctx context.Context, request ChangeSddcCompartmentRequest) (response ChangeSddcCompartmentResponse, err error)
ChangeSddcCompartment Moves an SDDC into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ChangeSddcCompartment.go.html to see an example of how to use ChangeSddcCompartment API. A default retry strategy applies to this operation ChangeSddcCompartment()
func (client *SddcClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client SddcClient) CreateSddc(ctx context.Context, request CreateSddcRequest) (response CreateSddcResponse, err error)
CreateSddc Creates an Oracle Cloud VMware Solution software-defined data center (SDDC). Use the WorkRequest operations to track the creation of the SDDC. **Important:** You must configure the SDDC's networking resources with the security rules detailed in Security Rules for Oracle Cloud VMware Solution SDDCs (https://docs.oracle.com/iaas/Content/VMware/Reference/ocvssecurityrules.htm). Otherwise, provisioning the SDDC will fail. The rules are based on the requirements set by VMware.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/CreateSddc.go.html to see an example of how to use CreateSddc API. A default retry strategy applies to this operation CreateSddc()
func (client SddcClient) DeleteSddc(ctx context.Context, request DeleteSddcRequest) (response DeleteSddcResponse, err error)
DeleteSddc Deletes the specified SDDC, along with the other resources that were created with the SDDC. For example: the Compute instances, DNS records, and so on. Use the WorkRequest operations to track the deletion of the SDDC.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/DeleteSddc.go.html to see an example of how to use DeleteSddc API. A default retry strategy applies to this operation DeleteSddc()
func (client SddcClient) DowngradeHcx(ctx context.Context, request DowngradeHcxRequest) (response DowngradeHcxResponse, err error)
DowngradeHcx Downgrade the specified SDDC from HCX Enterprise to HCX Advanced. SDDC with standard compute shapes will always use HCX Enterprise if HCX is enabled and cannot be downgraded. Downgrading from HCX Enterprise to HCX Advanced reduces the number of provided license keys from 10 to 3. Downgrade remains in a `PENDING` state until the end of the current billing cycle. You can use CancelDowngradeHcx to cancel the downgrade while it's still in a `PENDING` state.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/DowngradeHcx.go.html to see an example of how to use DowngradeHcx API. A default retry strategy applies to this operation DowngradeHcx()
func (client SddcClient) GetSddc(ctx context.Context, request GetSddcRequest) (response GetSddcResponse, err error)
GetSddc Gets the specified SDDC's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/GetSddc.go.html to see an example of how to use GetSddc API. A default retry strategy applies to this operation GetSddc()
func (client SddcClient) ListSddcs(ctx context.Context, request ListSddcsRequest) (response ListSddcsResponse, err error)
ListSddcs Lists the SDDCs in the specified compartment. The list can be filtered by display name or availability domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListSddcs.go.html to see an example of how to use ListSddcs API. A default retry strategy applies to this operation ListSddcs()
func (client SddcClient) ListSupportedCommitments(ctx context.Context, request ListSupportedCommitmentsRequest) (response ListSupportedCommitmentsResponse, err error)
ListSupportedCommitments Lists supported Commitments.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListSupportedCommitments.go.html to see an example of how to use ListSupportedCommitments API. A default retry strategy applies to this operation ListSupportedCommitments()
func (client SddcClient) ListSupportedHostShapes(ctx context.Context, request ListSupportedHostShapesRequest) (response ListSupportedHostShapesResponse, err error)
ListSupportedHostShapes Lists supported compute shapes for ESXi hosts.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListSupportedHostShapes.go.html to see an example of how to use ListSupportedHostShapes API. A default retry strategy applies to this operation ListSupportedHostShapes()
func (client SddcClient) ListSupportedVmwareSoftwareVersions(ctx context.Context, request ListSupportedVmwareSoftwareVersionsRequest) (response ListSupportedVmwareSoftwareVersionsResponse, err error)
ListSupportedVmwareSoftwareVersions Lists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListSupportedVmwareSoftwareVersions.go.html to see an example of how to use ListSupportedVmwareSoftwareVersions API. A default retry strategy applies to this operation ListSupportedVmwareSoftwareVersions()
func (client SddcClient) RefreshHcxLicenseStatus(ctx context.Context, request RefreshHcxLicenseStatusRequest) (response RefreshHcxLicenseStatusResponse, err error)
RefreshHcxLicenseStatus Refresh HCX on-premise licenses status of the specified SDDC.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/RefreshHcxLicenseStatus.go.html to see an example of how to use RefreshHcxLicenseStatus API. A default retry strategy applies to this operation RefreshHcxLicenseStatus()
func (client SddcClient) RetrievePassword(ctx context.Context, request RetrievePasswordRequest) (response RetrievePasswordResponse, err error)
RetrievePassword Retrieve the SDDC password.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/RetrievePassword.go.html to see an example of how to use RetrievePassword API. A default retry strategy applies to this operation RetrievePassword()
func (client *SddcClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client SddcClient) UpdateSddc(ctx context.Context, request UpdateSddcRequest) (response UpdateSddcResponse, err error)
UpdateSddc Updates the specified SDDC. **Important:** Updating an SDDC affects only certain attributes in the `Sddc` object and does not affect the VMware environment currently running in the SDDC. For more information, see UpdateSddcDetails.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/UpdateSddc.go.html to see an example of how to use UpdateSddc API. A default retry strategy applies to this operation UpdateSddc()
func (client SddcClient) UpgradeHcx(ctx context.Context, request UpgradeHcxRequest) (response UpgradeHcxResponse, err error)
UpgradeHcx Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/UpgradeHcx.go.html to see an example of how to use UpgradeHcx API. A default retry strategy applies to this operation UpgradeHcx()
SddcCollection A list of SDDCs.
type SddcCollection struct {
// A list of SDDCs.
Items []SddcSummary `mandatory:"true" json:"items"`
}
func (m SddcCollection) String() string
func (m SddcCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SddcPassword SDDC vCenter/NSX/HCX password.
type SddcPassword struct {
// SDDC password type.
PasswordType PasswordTypesEnum `mandatory:"true" json:"passwordType"`
// SDDC vCenter/NSX/HCX password context.
Value *string `mandatory:"true" json:"value"`
}
func (m SddcPassword) String() string
func (m SddcPassword) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SddcSummary A summary of the SDDC.
type SddcSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that
// contains the SDDC.
Id *string `mandatory:"true" json:"id"`
// A descriptive name for the SDDC. It must be unique, start with a letter, and contain only letters, digits,
// whitespaces, dashes and underscores.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// In general, this is a specific version of bundled VMware software supported by
// Oracle Cloud VMware Solution (see
// ListSupportedVmwareSoftwareVersions).
// This attribute is not guaranteed to reflect the version of
// software currently installed on the ESXi hosts in the SDDC. The purpose
// of this attribute is to show the version of software that the Oracle
// Cloud VMware Solution will install on any new ESXi hosts that you *add to this
// SDDC in the future* with CreateEsxiHost.
// Therefore, if you upgrade the existing ESXi hosts in the SDDC to use a newer
// version of bundled VMware software supported by the Oracle Cloud VMware Solution, you
// should use UpdateSddc to update the SDDC's
// `vmwareSoftwareVersion` with that new version.
VmwareSoftwareVersion *string `mandatory:"true" json:"vmwareSoftwareVersion"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that
// contains the SDDC.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The number of ESXi hosts in the SDDC.
ClustersCount *int `mandatory:"true" json:"clustersCount"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// HCX Fully Qualified Domain Name
HcxFqdn *string `mandatory:"false" json:"hcxFqdn"`
// HCX configuration of the SDDC.
HcxMode HcxModesEnum `mandatory:"false" json:"hcxMode,omitempty"`
// FQDN for vCenter
// Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com`
VcenterFqdn *string `mandatory:"false" json:"vcenterFqdn"`
// FQDN for NSX Manager
// Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com`
NsxManagerFqdn *string `mandatory:"false" json:"nsxManagerFqdn"`
// The date and time the SDDC was created, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the SDDC was updated, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the SDDC.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Indicates whether this SDDC is designated for only single ESXi host.
IsSingleHostSddc *bool `mandatory:"false" json:"isSingleHostSddc"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m SddcSummary) String() string
func (m SddcSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SortOrdersEnum Enum with underlying type: string
type SortOrdersEnum string
Set of constants representing the allowable values for SortOrdersEnum
const (
SortOrdersAsc SortOrdersEnum = "ASC"
SortOrdersDesc SortOrdersEnum = "DESC"
)
func GetMappingSortOrdersEnum(val string) (SortOrdersEnum, bool)
GetMappingSortOrdersEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrdersEnumValues() []SortOrdersEnum
GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum
SupportedCommitmentSummary A specific Commitment.
type SupportedCommitmentSummary struct {
// name of Commitment
Name CommitmentEnum `mandatory:"true" json:"name"`
}
func (m SupportedCommitmentSummary) String() string
func (m SupportedCommitmentSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SupportedCommitmentSummaryCollection A specific Commitment.
type SupportedCommitmentSummaryCollection struct {
// A list of the supported Commitments.
Items []SupportedCommitmentSummary `mandatory:"true" json:"items"`
}
func (m SupportedCommitmentSummaryCollection) String() string
func (m SupportedCommitmentSummaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SupportedEsxiSoftwareVersionSummary A specific version of bundled ESXi software supported by the Oracle Cloud VMware Solution.
type SupportedEsxiSoftwareVersionSummary struct {
// A short, unique string that identifies the version of bundled software.
Version *string `mandatory:"true" json:"version"`
// A description of the software in the bundle.
Description *string `mandatory:"true" json:"description"`
// A list of ESXi host shapes supported by the version of bundled software.
SupportedHostShapeNames []string `mandatory:"true" json:"supportedHostShapeNames"`
}
func (m SupportedEsxiSoftwareVersionSummary) String() string
func (m SupportedEsxiSoftwareVersionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SupportedHostShapeCollection A list of compute shapes supported by the Oracle Cloud VMware Solution.
type SupportedHostShapeCollection struct {
// A list of the supported compute shapes for ESXi hosts.
Items []SupportedHostShapeSummary `mandatory:"true" json:"items"`
}
func (m SupportedHostShapeCollection) String() string
func (m SupportedHostShapeCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SupportedHostShapeSummary A specific compute shape supported by the Oracle Cloud VMware Solution.
type SupportedHostShapeSummary struct {
// The name of the supported compute shape.
Name *string `mandatory:"true" json:"name"`
// The operations where you can use the shape. The operations can be CREATE_SDDC or CREATE_ESXI_HOST.
SupportedOperations []OperationTypesEnum `mandatory:"true" json:"supportedOperations"`
// The family of the shape. ESXi hosts of one SDDC must have the same shape family.
ShapeFamily *string `mandatory:"true" json:"shapeFamily"`
// The default OCPU count of the shape.
DefaultOcpuCount *float32 `mandatory:"false" json:"defaultOcpuCount"`
// Support OCPU count of the shape.
SupportedOcpuCount []float32 `mandatory:"false" json:"supportedOcpuCount"`
// Indicates whether the shape supports single host SDDCs.
IsSingleHostSddcSupported *bool `mandatory:"false" json:"isSingleHostSddcSupported"`
// The VMware software versions supported by the shape.
SupportedVmwareSoftwareVersions []string `mandatory:"false" json:"supportedVmwareSoftwareVersions"`
// Description of the shape.
Description *string `mandatory:"false" json:"description"`
// Indicates whether the shape supports shielded instances.
IsSupportShieldedInstances *bool `mandatory:"false" json:"isSupportShieldedInstances"`
// Whether the shape supports "MONTH" Commitment.
IsSupportMonthlyCommitment *bool `mandatory:"false" json:"isSupportMonthlyCommitment"`
}
func (m SupportedHostShapeSummary) String() string
func (m SupportedHostShapeSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SupportedVmwareSoftwareVersionCollection A list of the supported versions of bundled VMware software.
type SupportedVmwareSoftwareVersionCollection struct {
// A list of the supported versions of bundled VMware software.
Items []SupportedVmwareSoftwareVersionSummary `mandatory:"true" json:"items"`
}
func (m SupportedVmwareSoftwareVersionCollection) String() string
func (m SupportedVmwareSoftwareVersionCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SupportedVmwareSoftwareVersionSummary A specific version of bundled VMware software supported by the Oracle Cloud VMware Solution.
type SupportedVmwareSoftwareVersionSummary struct {
// A short, unique string that identifies the version of bundled software.
Version *string `mandatory:"true" json:"version"`
// A description of the software in the bundle.
Description *string `mandatory:"true" json:"description"`
// A list of supported ESXi software versions.
EsxiSoftwareVersions []SupportedEsxiSoftwareVersionSummary `mandatory:"false" json:"esxiSoftwareVersions"`
}
func (m SupportedVmwareSoftwareVersionSummary) String() string
func (m SupportedVmwareSoftwareVersionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SwapBillingRequest wrapper for the SwapBilling operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/SwapBilling.go.html to see an example of how to use SwapBillingRequest.
type SwapBillingRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host.
EsxiHostId *string `mandatory:"true" contributesTo:"path" name:"esxiHostId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the active ESXi Host to swap billing with current host.
SwapBillingHostId *string `mandatory:"true" contributesTo:"query" name:"swapBillingHostId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request SwapBillingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SwapBillingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SwapBillingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SwapBillingRequest) String() string
func (request SwapBillingRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SwapBillingResponse wrapper for the SwapBilling operation
type SwapBillingResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response SwapBillingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SwapBillingResponse) String() string
UpdateClusterDetails The Cluster information to be updated. **Important:** Only the `displayName`, `freeFormTags`, and `definedTags` attributes affect the existing Cluster. Changing the other attributes affects the `Cluster` object, but not the VMware environment currently running on that Cluster. Those other attributes are used by the Oracle Cloud VMware Solution *only* for new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost.
type UpdateClusterDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cluster.
// Cluster name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region.
DisplayName *string `mandatory:"false" json:"displayName"`
NetworkConfiguration *NetworkConfiguration `mandatory:"false" json:"networkConfiguration"`
// The version of bundled VMware software that the Oracle Cloud VMware Solution will
// install on any new ESXi hosts that you add to this Cluster in the future. To get a list of the available versions, use
// ListSupportedVmwareSoftwareVersions.
VmwareSoftwareVersion *string `mandatory:"false" json:"vmwareSoftwareVersion"`
// The version of bundled ESXi software that the Oracle Cloud VMware Solution will
// install on any new ESXi hosts that you add to this Cluster in the future unless a specific version is configured on the ESXi level.
// To get a list of the available versions, use
// ListSupportedVmwareSoftwareVersions.
EsxiSoftwareVersion *string `mandatory:"false" json:"esxiSoftwareVersion"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateClusterDetails) String() string
func (m UpdateClusterDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateClusterRequest wrapper for the UpdateCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/UpdateCluster.go.html to see an example of how to use UpdateClusterRequest.
type UpdateClusterRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC Cluster.
ClusterId *string `mandatory:"true" contributesTo:"path" name:"clusterId"`
// The information to be updated.
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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateClusterRequest) String() string
func (request UpdateClusterRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateClusterResponse wrapper for the UpdateCluster operation
type UpdateClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The Cluster instance
Cluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateClusterResponse) String() string
UpdateEsxiHostDetails The ESXi host information to be updated.
type UpdateEsxiHostDetails struct {
// A descriptive name for the ESXi host. It's changeable.
// Esxi Host name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the Cluster.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The billing option to switch to after the existing billing cycle ends.
// If `nextCommitment` is null or empty, `currentCommitment` continues to the next billing cycle.
// ListSupportedCommitments.
NextCommitment CommitmentEnum `mandatory:"false" json:"nextCommitment,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deleted ESXi Host with LeftOver billing cycle.
BillingDonorHostId *string `mandatory:"false" json:"billingDonorHostId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateEsxiHostDetails) String() string
func (m UpdateEsxiHostDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateEsxiHostRequest wrapper for the UpdateEsxiHost operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/UpdateEsxiHost.go.html to see an example of how to use UpdateEsxiHostRequest.
type UpdateEsxiHostRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host.
EsxiHostId *string `mandatory:"true" contributesTo:"path" name:"esxiHostId"`
// The information to be updated.
UpdateEsxiHostDetails `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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateEsxiHostRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateEsxiHostRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateEsxiHostRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateEsxiHostRequest) String() string
func (request UpdateEsxiHostRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateEsxiHostResponse wrapper for the UpdateEsxiHost operation
type UpdateEsxiHostResponse struct {
// The underlying http response
RawResponse *http.Response
// The EsxiHost instance
EsxiHost `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateEsxiHostResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateEsxiHostResponse) String() string
UpdateSddcDetails The SDDC information to be updated. **Important:** Only the `displayName`, `freeFormTags`, and `definedTags` attributes affect the existing SDDC. Changing the other attributes affects the `Sddc` object, but not the VMware environment currently running on that SDDC. Those other attributes are used by the Oracle Cloud VMware Solution *only* for new ESXi hosts that you add to this SDDC in the future with CreateEsxiHost.
type UpdateSddcDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
// SDDC name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region.
DisplayName *string `mandatory:"false" json:"displayName"`
// The version of bundled VMware software that the Oracle Cloud VMware Solution will
// install on any new ESXi hosts that you add to this SDDC in the future unless a specific version is configured on the Cluster level.
// For the list of versions supported by the Oracle Cloud VMware Solution, see
// ListSupportedVmwareSoftwareVersions).
VmwareSoftwareVersion *string `mandatory:"false" json:"vmwareSoftwareVersion"`
// The version of bundled ESXi software that the Oracle Cloud VMware Solution will
// install on any new ESXi hosts that you add to this SDDC in the future unless a specific version is configured on the Cluster level.
// For the list of versions supported by the Oracle Cloud VMware Solution, see
// ListSupportedVmwareSoftwareVersions).
EsxiSoftwareVersion *string `mandatory:"false" json:"esxiSoftwareVersion"`
// One or more public SSH keys to be included in the `~/.ssh/authorized_keys` file for
// the default user on each ESXi host, only when adding new ESXi hosts to this SDDC.
// Use a newline character to separate multiple keys.
// The SSH keys must be in the format required for the `authorized_keys` file.
SshAuthorizedKeys *string `mandatory:"false" json:"sshAuthorizedKeys"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateSddcDetails) String() string
func (m UpdateSddcDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSddcRequest wrapper for the UpdateSddc operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/UpdateSddc.go.html to see an example of how to use UpdateSddcRequest.
type UpdateSddcRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"`
// The information to be updated.
UpdateSddcDetails `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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateSddcRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSddcRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSddcRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSddcRequest) String() string
func (request UpdateSddcRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSddcResponse wrapper for the UpdateSddc operation
type UpdateSddcResponse struct {
// The underlying http response
RawResponse *http.Response
// The Sddc instance
Sddc `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateSddcResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSddcResponse) String() string
UpgradeHcxRequest wrapper for the UpgradeHcx operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/UpgradeHcx.go.html to see an example of how to use UpgradeHcxRequest.
type UpgradeHcxRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.
SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 identifier for the request. If you need to contact Oracle about a particular
// request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpgradeHcxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpgradeHcxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpgradeHcxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpgradeHcxRequest) String() string
func (request UpgradeHcxRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpgradeHcxResponse wrapper for the UpgradeHcx operation
type UpgradeHcxResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpgradeHcxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpgradeHcxResponse) String() string
VsphereLicense License for vSphere upgrade.
type VsphereLicense struct {
// vSphere license type.
LicenseType *string `mandatory:"true" json:"licenseType"`
// vSphere license key value.
LicenseKey *string `mandatory:"true" json:"licenseKey"`
}
func (m VsphereLicense) String() string
func (m VsphereLicense) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
VsphereTypesEnum Enum with underlying type: string
type VsphereTypesEnum string
Set of constants representing the allowable values for VsphereTypesEnum
const (
VsphereTypesManagement VsphereTypesEnum = "MANAGEMENT"
VsphereTypesWorkload VsphereTypesEnum = "WORKLOAD"
)
func GetMappingVsphereTypesEnum(val string) (VsphereTypesEnum, bool)
GetMappingVsphereTypesEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVsphereTypesEnumValues() []VsphereTypesEnum
GetVsphereTypesEnumValues Enumerates the set of values for VsphereTypesEnum
VsphereUpgradeObject Binary object needed for vSphere upgrade
type VsphereUpgradeObject struct {
// Binary object download link.
DownloadLink *string `mandatory:"true" json:"downloadLink"`
// Binary object description.
LinkDescription *string `mandatory:"true" json:"linkDescription"`
}
func (m VsphereUpgradeObject) String() string
func (m VsphereUpgradeObject) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequest An asynchronous work request.
type WorkRequest struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypesEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that
// contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// The percentage complete of the operation tracked by this work request.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`,
// in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request reached a terminal state, either `FAILED` OR
// `SUCCEEDED`. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestClient a client for WorkRequest
type WorkRequestClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewWorkRequestClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestClient, err error)
NewWorkRequestClientWithConfigurationProvider Creates a new default WorkRequest client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewWorkRequestClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestClient, err error)
NewWorkRequestClientWithOboToken Creates a new default WorkRequest client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *WorkRequestClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client WorkRequestClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the specified work request's information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client WorkRequestClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists the errors for the specified work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client WorkRequestClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs for the specified work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client WorkRequestClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocvp/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *WorkRequestClient) SetRegion(region string)
SetRegion overrides the region of this client.
WorkRequestCollection A list of work requests.
type WorkRequestCollection struct {
// A list of work requests.
Items []WorkRequest `mandatory:"true" json:"items"`
}
func (m WorkRequestCollection) String() string
func (m WorkRequestCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing an operation that is tracked by a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred.
Code *string `mandatory:"true" json:"code"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
// The date and time the error occurred, in the format defined
// by RFC3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection A list of work request errors.
type WorkRequestErrorCollection struct {
// A list of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from executing an operation that is tracked by a work request.
type WorkRequestLogEntry struct {
// A human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The date and time the log message was written, in the format defined
// by RFC3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection A list of work request logs.
type WorkRequestLogEntryCollection struct {
// A list of work request logs.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource A resource that is created or operated on by an asynchronous operation that is tracked by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource was affected by the operation that spawned the
// work request.
ActionType ActionTypesEnum `mandatory:"true" json:"actionType"`
// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier
// for the resource.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that you can use for a GET request to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly