...

Package ocvp

import "github.com/oracle/oci-go-sdk/ocvp"
Overview
Index

Overview ▾

Index ▾

type ActionTypesEnum
    func GetActionTypesEnumValues() []ActionTypesEnum
type ChangeSddcCompartmentDetails
    func (m ChangeSddcCompartmentDetails) String() string
type ChangeSddcCompartmentRequest
    func (request ChangeSddcCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeSddcCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeSddcCompartmentRequest) String() string
type ChangeSddcCompartmentResponse
    func (response ChangeSddcCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeSddcCompartmentResponse) String() string
type CreateEsxiHostDetails
    func (m CreateEsxiHostDetails) String() string
type CreateEsxiHostRequest
    func (request CreateEsxiHostRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateEsxiHostRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateEsxiHostRequest) String() string
type CreateEsxiHostResponse
    func (response CreateEsxiHostResponse) HTTPResponse() *http.Response
    func (response CreateEsxiHostResponse) String() string
type CreateSddcDetails
    func (m CreateSddcDetails) String() string
type CreateSddcRequest
    func (request CreateSddcRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateSddcRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateSddcRequest) String() string
type CreateSddcResponse
    func (response CreateSddcResponse) HTTPResponse() *http.Response
    func (response CreateSddcResponse) String() string
type DeleteEsxiHostRequest
    func (request DeleteEsxiHostRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteEsxiHostRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteEsxiHostRequest) String() string
type DeleteEsxiHostResponse
    func (response DeleteEsxiHostResponse) HTTPResponse() *http.Response
    func (response DeleteEsxiHostResponse) String() string
type DeleteSddcRequest
    func (request DeleteSddcRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteSddcRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteSddcRequest) String() string
type DeleteSddcResponse
    func (response DeleteSddcResponse) HTTPResponse() *http.Response
    func (response DeleteSddcResponse) String() string
type EsxiHost
    func (m EsxiHost) String() string
type EsxiHostClient
    func NewEsxiHostClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client EsxiHostClient, err error)
    func NewEsxiHostClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client EsxiHostClient, err error)
    func (client *EsxiHostClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client EsxiHostClient) CreateEsxiHost(ctx context.Context, request CreateEsxiHostRequest) (response CreateEsxiHostResponse, err error)
    func (client EsxiHostClient) DeleteEsxiHost(ctx context.Context, request DeleteEsxiHostRequest) (response DeleteEsxiHostResponse, err error)
    func (client EsxiHostClient) GetEsxiHost(ctx context.Context, request GetEsxiHostRequest) (response GetEsxiHostResponse, err error)
    func (client EsxiHostClient) ListEsxiHosts(ctx context.Context, request ListEsxiHostsRequest) (response ListEsxiHostsResponse, err error)
    func (client *EsxiHostClient) SetRegion(region string)
    func (client EsxiHostClient) UpdateEsxiHost(ctx context.Context, request UpdateEsxiHostRequest) (response UpdateEsxiHostResponse, err error)
type EsxiHostCollection
    func (m EsxiHostCollection) String() string
type EsxiHostSummary
    func (m EsxiHostSummary) String() string
type GetEsxiHostRequest
    func (request GetEsxiHostRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetEsxiHostRequest) RetryPolicy() *common.RetryPolicy
    func (request GetEsxiHostRequest) String() string
type GetEsxiHostResponse
    func (response GetEsxiHostResponse) HTTPResponse() *http.Response
    func (response GetEsxiHostResponse) String() string
type GetSddcRequest
    func (request GetSddcRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetSddcRequest) RetryPolicy() *common.RetryPolicy
    func (request GetSddcRequest) String() string
type GetSddcResponse
    func (response GetSddcResponse) HTTPResponse() *http.Response
    func (response GetSddcResponse) String() string
type GetWorkRequestRequest
    func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request GetWorkRequestRequest) String() string
type GetWorkRequestResponse
    func (response GetWorkRequestResponse) HTTPResponse() *http.Response
    func (response GetWorkRequestResponse) String() string
type LifecycleStatesEnum
    func GetLifecycleStatesEnumValues() []LifecycleStatesEnum
type ListEsxiHostsLifecycleStateEnum
    func GetListEsxiHostsLifecycleStateEnumValues() []ListEsxiHostsLifecycleStateEnum
type ListEsxiHostsRequest
    func (request ListEsxiHostsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListEsxiHostsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListEsxiHostsRequest) String() string
type ListEsxiHostsResponse
    func (response ListEsxiHostsResponse) HTTPResponse() *http.Response
    func (response ListEsxiHostsResponse) String() string
type ListEsxiHostsSortByEnum
    func GetListEsxiHostsSortByEnumValues() []ListEsxiHostsSortByEnum
type ListEsxiHostsSortOrderEnum
    func GetListEsxiHostsSortOrderEnumValues() []ListEsxiHostsSortOrderEnum
type ListSddcsLifecycleStateEnum
    func GetListSddcsLifecycleStateEnumValues() []ListSddcsLifecycleStateEnum
type ListSddcsRequest
    func (request ListSddcsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListSddcsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListSddcsRequest) String() string
type ListSddcsResponse
    func (response ListSddcsResponse) HTTPResponse() *http.Response
    func (response ListSddcsResponse) String() string
type ListSddcsSortByEnum
    func GetListSddcsSortByEnumValues() []ListSddcsSortByEnum
type ListSddcsSortOrderEnum
    func GetListSddcsSortOrderEnumValues() []ListSddcsSortOrderEnum
type ListSupportedVmwareSoftwareVersionsRequest
    func (request ListSupportedVmwareSoftwareVersionsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListSupportedVmwareSoftwareVersionsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListSupportedVmwareSoftwareVersionsRequest) String() string
type ListSupportedVmwareSoftwareVersionsResponse
    func (response ListSupportedVmwareSoftwareVersionsResponse) HTTPResponse() *http.Response
    func (response ListSupportedVmwareSoftwareVersionsResponse) String() string
type ListWorkRequestErrorsRequest
    func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestErrorsRequest) String() string
type ListWorkRequestErrorsResponse
    func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestErrorsResponse) String() string
type ListWorkRequestLogsRequest
    func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestLogsRequest) String() string
type ListWorkRequestLogsResponse
    func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestLogsResponse) String() string
type ListWorkRequestsRequest
    func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestsRequest) String() string
type ListWorkRequestsResponse
    func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestsResponse) String() string
type OperationStatusEnum
    func GetOperationStatusEnumValues() []OperationStatusEnum
type OperationTypesEnum
    func GetOperationTypesEnumValues() []OperationTypesEnum
type Sddc
    func (m Sddc) String() string
type SddcClient
    func NewSddcClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SddcClient, err error)
    func NewSddcClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SddcClient, err error)
    func (client SddcClient) ChangeSddcCompartment(ctx context.Context, request ChangeSddcCompartmentRequest) (response ChangeSddcCompartmentResponse, err error)
    func (client *SddcClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client SddcClient) CreateSddc(ctx context.Context, request CreateSddcRequest) (response CreateSddcResponse, err error)
    func (client SddcClient) DeleteSddc(ctx context.Context, request DeleteSddcRequest) (response DeleteSddcResponse, err error)
    func (client SddcClient) GetSddc(ctx context.Context, request GetSddcRequest) (response GetSddcResponse, err error)
    func (client SddcClient) ListSddcs(ctx context.Context, request ListSddcsRequest) (response ListSddcsResponse, err error)
    func (client SddcClient) ListSupportedVmwareSoftwareVersions(ctx context.Context, request ListSupportedVmwareSoftwareVersionsRequest) (response ListSupportedVmwareSoftwareVersionsResponse, err error)
    func (client *SddcClient) SetRegion(region string)
    func (client SddcClient) UpdateSddc(ctx context.Context, request UpdateSddcRequest) (response UpdateSddcResponse, err error)
type SddcCollection
    func (m SddcCollection) String() string
type SddcSummary
    func (m SddcSummary) String() string
type SortOrdersEnum
    func GetSortOrdersEnumValues() []SortOrdersEnum
type SupportedVmwareSoftwareVersionCollection
    func (m SupportedVmwareSoftwareVersionCollection) String() string
type SupportedVmwareSoftwareVersionSummary
    func (m SupportedVmwareSoftwareVersionSummary) String() string
type UpdateEsxiHostDetails
    func (m UpdateEsxiHostDetails) String() string
type UpdateEsxiHostRequest
    func (request UpdateEsxiHostRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateEsxiHostRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateEsxiHostRequest) String() string
type UpdateEsxiHostResponse
    func (response UpdateEsxiHostResponse) HTTPResponse() *http.Response
    func (response UpdateEsxiHostResponse) String() string
type UpdateSddcDetails
    func (m UpdateSddcDetails) String() string
type UpdateSddcRequest
    func (request UpdateSddcRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateSddcRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateSddcRequest) String() string
type UpdateSddcResponse
    func (response UpdateSddcResponse) HTTPResponse() *http.Response
    func (response UpdateSddcResponse) String() string
type WorkRequest
    func (m WorkRequest) String() string
type WorkRequestClient
    func NewWorkRequestClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestClient, err error)
    func NewWorkRequestClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestClient, err error)
    func (client *WorkRequestClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client WorkRequestClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
    func (client WorkRequestClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
    func (client WorkRequestClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
    func (client WorkRequestClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
    func (client *WorkRequestClient) SetRegion(region string)
type WorkRequestCollection
    func (m WorkRequestCollection) String() string
type WorkRequestError
    func (m WorkRequestError) String() string
type WorkRequestErrorCollection
    func (m WorkRequestErrorCollection) String() string
type WorkRequestLogEntry
    func (m WorkRequestLogEntry) String() string
type WorkRequestLogEntryCollection
    func (m WorkRequestLogEntryCollection) String() string
type WorkRequestResource
    func (m WorkRequestResource) String() string

Package files

action_types.go change_sddc_compartment_details.go change_sddc_compartment_request_response.go create_esxi_host_details.go create_esxi_host_request_response.go create_sddc_details.go create_sddc_request_response.go delete_esxi_host_request_response.go delete_sddc_request_response.go esxi_host.go esxi_host_collection.go esxi_host_summary.go get_esxi_host_request_response.go get_sddc_request_response.go get_work_request_request_response.go lifecycle_states.go list_esxi_hosts_request_response.go list_sddcs_request_response.go list_supported_vmware_software_versions_request_response.go list_work_request_errors_request_response.go list_work_request_logs_request_response.go list_work_requests_request_response.go ocvp_esxihost_client.go ocvp_sddc_client.go ocvp_workrequest_client.go operation_status.go operation_types.go sddc.go sddc_collection.go sddc_summary.go sort_orders.go supported_vmware_software_version_collection.go supported_vmware_software_version_summary.go update_esxi_host_details.go update_esxi_host_request_response.go update_sddc_details.go update_sddc_request_response.go work_request.go work_request_collection.go work_request_error.go work_request_error_collection.go work_request_log_entry.go work_request_log_entry_collection.go work_request_resource.go

type ActionTypesEnum

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

func GetActionTypesEnumValues

func GetActionTypesEnumValues() []ActionTypesEnum

GetActionTypesEnumValues Enumerates the set of values for ActionTypesEnum

type ChangeSddcCompartmentDetails

ChangeSddcCompartmentDetails The configuration details for the move operation.

type ChangeSddcCompartmentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment to move
    // the SDDC to.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

func (ChangeSddcCompartmentDetails) String

func (m ChangeSddcCompartmentDetails) String() string

type ChangeSddcCompartmentRequest

ChangeSddcCompartmentRequest wrapper for the ChangeSddcCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ChangeSddcCompartment.go.html to see an example of how to use ChangeSddcCompartmentRequest.

type ChangeSddcCompartmentRequest struct {

    // The OCID (https://docs.cloud.oracle.com/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 (ChangeSddcCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeSddcCompartmentRequest) RetryPolicy

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

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

func (ChangeSddcCompartmentRequest) String

func (request ChangeSddcCompartmentRequest) String() string

type ChangeSddcCompartmentResponse

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 (ChangeSddcCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeSddcCompartmentResponse) String

func (response ChangeSddcCompartmentResponse) String() string

type CreateEsxiHostDetails

CreateEsxiHostDetails Details of the ESXi host to add to the SDDC.

type CreateEsxiHostDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC to add the
    // ESXi host to.
    SddcId *string `mandatory:"true" json:"sddcId"`

    // 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 SDDC.
    // If this attribute is not specified, the SDDC'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 SDDC, and `instanceDisplayNamePrefix` is `MySDDC`, the host's display
    // name is `MySDDC-4`.
    // Avoid entering confidential information.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // 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.cloud.oracle.com/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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateEsxiHostDetails) String

func (m CreateEsxiHostDetails) String() string

type CreateEsxiHostRequest

CreateEsxiHostRequest wrapper for the CreateEsxiHost operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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 (CreateEsxiHostRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateEsxiHostRequest) RetryPolicy

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

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

func (CreateEsxiHostRequest) String

func (request CreateEsxiHostRequest) String() string

type CreateEsxiHostResponse

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 (CreateEsxiHostResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateEsxiHostResponse) String

func (response CreateEsxiHostResponse) String() string

type CreateSddcDetails

CreateSddcDetails Details of the SDDC.

type CreateSddcDetails struct {

    // The availability domain to create the SDDC's ESXi hosts in.
    ComputeAvailabilityDomain *string `mandatory:"true" json:"computeAvailabilityDomain"`

    // 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.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment to contain the SDDC.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The number of ESXi hosts to create in the SDDC. You can add more hosts later
    // (see CreateEsxiHost).
    // **Note:** If you later 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.
    EsxiHostsCount *int `mandatory:"true" json:"esxiHostsCount"`

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

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the management subnet to use
    // for provisioning the SDDC.
    ProvisioningSubnetId *string `mandatory:"true" json:"provisioningSubnetId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the vSphere
    // component of the VMware environment.
    VsphereVlanId *string `mandatory:"true" json:"vsphereVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the vMotion
    // component of the VMware environment.
    VmotionVlanId *string `mandatory:"true" json:"vmotionVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the vSAN
    // component of the VMware environment.
    VsanVlanId *string `mandatory:"true" json:"vsanVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the NSX VTEP
    // component of the VMware environment.
    NsxVTepVlanId *string `mandatory:"true" json:"nsxVTepVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the NSX Edge VTEP
    // component of the VMware environment.
    NsxEdgeVTepVlanId *string `mandatory:"true" json:"nsxEdgeVTepVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the NSX Edge
    // Uplink 1 component of the VMware environment.
    NsxEdgeUplink1VlanId *string `mandatory:"true" json:"nsxEdgeUplink1VlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the NSX Edge
    // Uplink 2 component of the VMware environment.
    NsxEdgeUplink2VlanId *string `mandatory:"true" json:"nsxEdgeUplink2VlanId"`

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

    // A prefix used in the name of each ESXi host and Compute instance in the SDDC.
    // If this isn't set, the SDDC's `displayName` is used as the prefix.
    // For example, if the value is `mySDDC`, the ESXi hosts are named `mySDDC-1`,
    // `mySDDC-2`, and so on.
    InstanceDisplayNamePrefix *string `mandatory:"false" json:"instanceDisplayNamePrefix"`

    // This flag tells us if HCX is enabled or not.
    IsHcxEnabled *bool `mandatory:"false" json:"isHcxEnabled"`

    // This id is required only when hcxEnabled is true
    HcxVlanId *string `mandatory:"false" json:"hcxVlanId"`

    // The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application
    // workloads.
    WorkloadNetworkCidr *string `mandatory:"false" json:"workloadNetworkCidr"`

    // 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.cloud.oracle.com/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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateSddcDetails) String

func (m CreateSddcDetails) String() string

type CreateSddcRequest

CreateSddcRequest wrapper for the CreateSddc operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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 (CreateSddcRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateSddcRequest) RetryPolicy

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

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

func (CreateSddcRequest) String

func (request CreateSddcRequest) String() string

type CreateSddcResponse

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 (CreateSddcResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateSddcResponse) String

func (response CreateSddcResponse) String() string

type DeleteEsxiHostRequest

DeleteEsxiHostRequest wrapper for the DeleteEsxiHost operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/DeleteEsxiHost.go.html to see an example of how to use DeleteEsxiHostRequest.

type DeleteEsxiHostRequest struct {

    // The OCID (https://docs.cloud.oracle.com/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 (DeleteEsxiHostRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteEsxiHostRequest) RetryPolicy

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

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

func (DeleteEsxiHostRequest) String

func (request DeleteEsxiHostRequest) String() string

type DeleteEsxiHostResponse

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 (DeleteEsxiHostResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteEsxiHostResponse) String

func (response DeleteEsxiHostResponse) String() string

type DeleteSddcRequest

DeleteSddcRequest wrapper for the DeleteSddc operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/DeleteSddc.go.html to see an example of how to use DeleteSddcRequest.

type DeleteSddcRequest struct {

    // The OCID (https://docs.cloud.oracle.com/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 (DeleteSddcRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteSddcRequest) RetryPolicy

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

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

func (DeleteSddcRequest) String

func (request DeleteSddcRequest) String() string

type DeleteSddcResponse

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 (DeleteSddcResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteSddcResponse) String

func (response DeleteSddcResponse) String() string

type EsxiHost

EsxiHost An ESXi host is a node in an SDDC. At a minimum, each SDDC 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.cloud.oracle.com/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.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC that the
    // ESXi host belongs to.
    SddcId *string `mandatory:"true" json:"sddcId"`

    // 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.cloud.oracle.com/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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that
    // contains the SDDC.
    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.cloud.oracle.com/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"`
}

func (EsxiHost) String

func (m EsxiHost) String() string

type EsxiHostClient

EsxiHostClient a client for EsxiHost

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

func NewEsxiHostClientWithConfigurationProvider

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

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

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

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

func (EsxiHostClient) CreateEsxiHost

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/CreateEsxiHost.go.html to see an example of how to use CreateEsxiHost API.

func (EsxiHostClient) DeleteEsxiHost

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/DeleteEsxiHost.go.html to see an example of how to use DeleteEsxiHost API.

func (EsxiHostClient) GetEsxiHost

func (client EsxiHostClient) GetEsxiHost(ctx context.Context, request GetEsxiHostRequest) (response GetEsxiHostResponse, err error)

GetEsxiHost Gets the specified ESXi host's information.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/GetEsxiHost.go.html to see an example of how to use GetEsxiHost API.

func (EsxiHostClient) ListEsxiHosts

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListEsxiHosts.go.html to see an example of how to use ListEsxiHosts API.

func (*EsxiHostClient) SetRegion

func (client *EsxiHostClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (EsxiHostClient) UpdateEsxiHost

func (client EsxiHostClient) UpdateEsxiHost(ctx context.Context, request UpdateEsxiHostRequest) (response UpdateEsxiHostResponse, err error)

UpdateEsxiHost Updates the specified ESXi host.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/UpdateEsxiHost.go.html to see an example of how to use UpdateEsxiHost API.

type EsxiHostCollection

EsxiHostCollection A list of ESXi hosts.

type EsxiHostCollection struct {

    // A list of ESXi hosts.
    Items []EsxiHostSummary `mandatory:"true" json:"items"`
}

func (EsxiHostCollection) String

func (m EsxiHostCollection) String() string

type EsxiHostSummary

EsxiHostSummary A summary of the ESXi host.

type EsxiHostSummary struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the ESXi host.
    Id *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC that the
    // ESXi host belongs to.
    SddcId *string `mandatory:"true" json:"sddcId"`

    // 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.cloud.oracle.com/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.cloud.oracle.com/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.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that
    // contains the SDDC.
    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.cloud.oracle.com/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"`
}

func (EsxiHostSummary) String

func (m EsxiHostSummary) String() string

type GetEsxiHostRequest

GetEsxiHostRequest wrapper for the GetEsxiHost operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/GetEsxiHost.go.html to see an example of how to use GetEsxiHostRequest.

type GetEsxiHostRequest struct {

    // The OCID (https://docs.cloud.oracle.com/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 (GetEsxiHostRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetEsxiHostRequest) RetryPolicy

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

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

func (GetEsxiHostRequest) String

func (request GetEsxiHostRequest) String() string

type GetEsxiHostResponse

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 (GetEsxiHostResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetEsxiHostResponse) String

func (response GetEsxiHostResponse) String() string

type GetSddcRequest

GetSddcRequest wrapper for the GetSddc operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/GetSddc.go.html to see an example of how to use GetSddcRequest.

type GetSddcRequest struct {

    // The OCID (https://docs.cloud.oracle.com/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 (GetSddcRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetSddcRequest) RetryPolicy

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

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

func (GetSddcRequest) String

func (request GetSddcRequest) String() string

type GetSddcResponse

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 (GetSddcResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetSddcResponse) String

func (response GetSddcResponse) String() string

type GetWorkRequestRequest

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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

type GetWorkRequestRequest struct {

    // The OCID (https://docs.cloud.oracle.com/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 (GetWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse

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 (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type LifecycleStatesEnum

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

func GetLifecycleStatesEnumValues() []LifecycleStatesEnum

GetLifecycleStatesEnumValues Enumerates the set of values for LifecycleStatesEnum

type ListEsxiHostsLifecycleStateEnum

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

func GetListEsxiHostsLifecycleStateEnumValues() []ListEsxiHostsLifecycleStateEnum

GetListEsxiHostsLifecycleStateEnumValues Enumerates the set of values for ListEsxiHostsLifecycleStateEnum

type ListEsxiHostsRequest

ListEsxiHostsRequest wrapper for the ListEsxiHosts operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListEsxiHosts.go.html to see an example of how to use ListEsxiHostsRequest.

type ListEsxiHostsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC.
    SddcId *string `mandatory:"false" contributesTo:"query" name:"sddcId"`

    // The OCID (https://docs.cloud.oracle.com/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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response header from the previous "List"
    // call. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The 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"`

    // 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 (ListEsxiHostsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListEsxiHostsRequest) RetryPolicy

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

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

func (ListEsxiHostsRequest) String

func (request ListEsxiHostsRequest) String() string

type ListEsxiHostsResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (ListEsxiHostsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListEsxiHostsResponse) String

func (response ListEsxiHostsResponse) String() string

type ListEsxiHostsSortByEnum

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

func GetListEsxiHostsSortByEnumValues() []ListEsxiHostsSortByEnum

GetListEsxiHostsSortByEnumValues Enumerates the set of values for ListEsxiHostsSortByEnum

type ListEsxiHostsSortOrderEnum

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

func GetListEsxiHostsSortOrderEnumValues() []ListEsxiHostsSortOrderEnum

GetListEsxiHostsSortOrderEnumValues Enumerates the set of values for ListEsxiHostsSortOrderEnum

type ListSddcsLifecycleStateEnum

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

func GetListSddcsLifecycleStateEnumValues() []ListSddcsLifecycleStateEnum

GetListSddcsLifecycleStateEnumValues Enumerates the set of values for ListSddcsLifecycleStateEnum

type ListSddcsRequest

ListSddcsRequest wrapper for the ListSddcs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListSddcs.go.html to see an example of how to use ListSddcsRequest.

type ListSddcsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response header from the previous "List"
    // call. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The 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 (ListSddcsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListSddcsRequest) RetryPolicy

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

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

func (ListSddcsRequest) String

func (request ListSddcsRequest) String() string

type ListSddcsResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (ListSddcsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListSddcsResponse) String

func (response ListSddcsResponse) String() string

type ListSddcsSortByEnum

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

func GetListSddcsSortByEnumValues() []ListSddcsSortByEnum

GetListSddcsSortByEnumValues Enumerates the set of values for ListSddcsSortByEnum

type ListSddcsSortOrderEnum

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

func GetListSddcsSortOrderEnumValues() []ListSddcsSortOrderEnum

GetListSddcsSortOrderEnumValues Enumerates the set of values for ListSddcsSortOrderEnum

type ListSupportedVmwareSoftwareVersionsRequest

ListSupportedVmwareSoftwareVersionsRequest wrapper for the ListSupportedVmwareSoftwareVersions operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListSupportedVmwareSoftwareVersions.go.html to see an example of how to use ListSupportedVmwareSoftwareVersionsRequest.

type ListSupportedVmwareSoftwareVersionsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response header from the previous "List"
    // call. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Unique 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 (ListSupportedVmwareSoftwareVersionsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListSupportedVmwareSoftwareVersionsRequest) RetryPolicy

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

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

func (ListSupportedVmwareSoftwareVersionsRequest) String

func (request ListSupportedVmwareSoftwareVersionsRequest) String() string

type ListSupportedVmwareSoftwareVersionsResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (ListSupportedVmwareSoftwareVersionsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListSupportedVmwareSoftwareVersionsResponse) String

func (response ListSupportedVmwareSoftwareVersionsResponse) String() string

type ListWorkRequestErrorsRequest

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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

type ListWorkRequestErrorsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // For list pagination. The maximum number of results per page, or items to return in a paginated
    // "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // 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 (ListWorkRequestErrorsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

type ListWorkRequestErrorsResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestLogsRequest

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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

type ListWorkRequestLogsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // For list pagination. The maximum number of results per page, or items to return in a paginated
    // "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // 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 (ListWorkRequestLogsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

type ListWorkRequestLogsResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestsRequest

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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

type ListWorkRequestsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The OCID (https://docs.cloud.oracle.com/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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // For list pagination. The maximum number of results per page, or items to return in a paginated
    // "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // 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 (ListWorkRequestsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type OperationStatusEnum

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 GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypesEnum

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"
    OperationTypesCreateEsxiHost OperationTypesEnum = "CREATE_ESXI_HOST"
    OperationTypesDeleteEsxiHost OperationTypesEnum = "DELETE_ESXI_HOST"
)

func GetOperationTypesEnumValues

func GetOperationTypesEnumValues() []OperationTypesEnum

GetOperationTypesEnumValues Enumerates the set of values for OperationTypesEnum

type Sddc

Sddc A 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.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC.
    Id *string `mandatory:"true" json:"id"`

    // The availability domain the ESXi hosts are running in.
    // Example: `Uocm:PHX-AD-1`
    ComputeAvailabilityDomain *string `mandatory:"true" json:"computeAvailabilityDomain"`

    // 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.cloud.oracle.com/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.
    EsxiHostsCount *int `mandatory:"true" json:"esxiHostsCount"`

    // FQDN for vCenter
    // Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com`
    VcenterFqdn *string `mandatory:"true" json:"vcenterFqdn"`

    // FQDN for NSX Manager
    // Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com`
    NsxManagerFqdn *string `mandatory:"true" json:"nsxManagerFqdn"`

    // The OCID (https://docs.cloud.oracle.com/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.cloud.oracle.com/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"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the management subnet used
    // to provision the SDDC.
    ProvisioningSubnetId *string `mandatory:"true" json:"provisioningSubnetId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC
    // for the vSphere component of the VMware environment.
    // This attribute is not guaranteed to reflect the vSphere VLAN
    // currently used by the ESXi hosts in the SDDC. 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
    // SDDC in the future* with CreateEsxiHost.
    // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN
    // for the vSphere component of the VMware environment, you
    // should use UpdateSddc to update the SDDC's
    // `vsphereVlanId` with that new VLAN's OCID.
    VsphereVlanId *string `mandatory:"true" json:"vsphereVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC
    // 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 SDDC. 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
    // SDDC in the future* with CreateEsxiHost.
    // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN
    // for the vMotion component of the VMware environment, you
    // should use UpdateSddc to update the SDDC's
    // `vmotionVlanId` with that new VLAN's OCID.
    VmotionVlanId *string `mandatory:"true" json:"vmotionVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC
    // 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 SDDC. 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
    // SDDC in the future* with CreateEsxiHost.
    // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN
    // for the vSAN component of the VMware environment, you
    // should use UpdateSddc to update the SDDC's
    // `vsanVlanId` with that new VLAN's OCID.
    VsanVlanId *string `mandatory:"true" json:"vsanVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC
    // 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 SDDC. 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
    // SDDC in the future* with CreateEsxiHost.
    // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN
    // for the NSX VTEP component of the VMware environment, you
    // should use UpdateSddc to update the SDDC's
    // `nsxVTepVlanId` with that new VLAN's OCID.
    NsxVTepVlanId *string `mandatory:"true" json:"nsxVTepVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC
    // 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 SDDC. 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
    // SDDC in the future* with CreateEsxiHost.
    // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN
    // for the NSX Edge VTEP component of the VMware environment, you
    // should use UpdateSddc to update the SDDC's
    // `nsxEdgeVTepVlanId` with that new VLAN's OCID.
    NsxEdgeVTepVlanId *string `mandatory:"true" json:"nsxEdgeVTepVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC
    // for the NSX Edge Uplink 1 component of the VMware environment.
    // This attribute is not guaranteed to reflect the NSX Edge Uplink 1 VLAN
    // currently used by the ESXi hosts in the SDDC. 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
    // SDDC in the future* with CreateEsxiHost.
    // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN
    // for the NSX Edge Uplink 1 component of the VMware environment, you
    // should use UpdateSddc to update the SDDC's
    // `nsxEdgeUplink1VlanId` with that new VLAN's OCID.
    NsxEdgeUplink1VlanId *string `mandatory:"true" json:"nsxEdgeUplink1VlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC
    // for the NSX Edge Uplink 2 component of the VMware environment.
    // This attribute is not guaranteed to reflect the NSX Edge Uplink 2 VLAN
    // currently used by the ESXi hosts in the SDDC. 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
    // SDDC in the future* with CreateEsxiHost.
    // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN
    // for the NSX Edge Uplink 2 component of the VMware environment, you
    // should use UpdateSddc to update the SDDC's
    // `nsxEdgeUplink2VlanId` with that new VLAN's OCID.
    NsxEdgeUplink2VlanId *string `mandatory:"true" json:"nsxEdgeUplink2VlanId"`

    // 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.cloud.oracle.com/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.cloud.oracle.com/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 SDDC.
    // If this isn't set, the SDDC's `displayName` is used as the prefix.
    // For example, if the value is `MySDDC`, the ESXi hosts are named `MySDDC-1`,
    // `MySDDC-2`, and so on.
    InstanceDisplayNamePrefix *string `mandatory:"false" json:"instanceDisplayNamePrefix"`

    // The SDDC includes an administrator username and initial password for vCenter. Make sure
    // to change this initial vCenter password to a different value.
    VcenterInitialPassword *string `mandatory:"false" json:"vcenterInitialPassword"`

    // The SDDC includes an administrator username and initial password for NSX Manager. Make sure
    // to change this initial NSX Manager password to a different value.
    NsxManagerInitialPassword *string `mandatory:"false" json:"nsxManagerInitialPassword"`

    // The SDDC includes an administrator username and initial 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 CIDR block for the IP addresses that VMware VMs in the SDDC use to run application
    // workloads.
    WorkloadNetworkCidr *string `mandatory:"false" json:"workloadNetworkCidr"`

    // The VMware NSX overlay workload segment to host your application. Connect to workload
    // portgroup in vCenter to access this overlay segment.
    NsxOverlaySegmentName *string `mandatory:"false" json:"nsxOverlaySegmentName"`

    // The OCID (https://docs.cloud.oracle.com/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"`

    // HCX Private IP
    HcxPrivateIpId *string `mandatory:"false" json:"hcxPrivateIpId"`

    // HCX Fully Qualified Domain Name
    HcxFqdn *string `mandatory:"false" json:"hcxFqdn"`

    // HCX initial password
    HcxInitialPassword *string `mandatory:"false" json:"hcxInitialPassword"`

    // HCX vlan id
    HcxVlanId *string `mandatory:"false" json:"hcxVlanId"`

    // HCX enabled or not
    IsHcxEnabled *bool `mandatory:"false" json:"isHcxEnabled"`

    // HCX on-premise license key
    HcxOnPremKey *string `mandatory:"false" json:"hcxOnPremKey"`

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

func (Sddc) String

func (m Sddc) String() string

type SddcClient

SddcClient a client for Sddc

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

func NewSddcClientWithConfigurationProvider

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

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 (SddcClient) ChangeSddcCompartment

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.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ChangeSddcCompartment.go.html to see an example of how to use ChangeSddcCompartment API.

func (*SddcClient) ConfigurationProvider

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

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

func (SddcClient) CreateSddc

func (client SddcClient) CreateSddc(ctx context.Context, request CreateSddcRequest) (response CreateSddcResponse, err error)

CreateSddc Creates a software-defined data center (SDDC). Use the WorkRequest operations to track the creation of the SDDC.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/CreateSddc.go.html to see an example of how to use CreateSddc API.

func (SddcClient) DeleteSddc

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/DeleteSddc.go.html to see an example of how to use DeleteSddc API.

func (SddcClient) GetSddc

func (client SddcClient) GetSddc(ctx context.Context, request GetSddcRequest) (response GetSddcResponse, err error)

GetSddc Gets the specified SDDC's information.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/GetSddc.go.html to see an example of how to use GetSddc API.

func (SddcClient) ListSddcs

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListSddcs.go.html to see an example of how to use ListSddcs API.

func (SddcClient) ListSupportedVmwareSoftwareVersions

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListSupportedVmwareSoftwareVersions.go.html to see an example of how to use ListSupportedVmwareSoftwareVersions API.

func (*SddcClient) SetRegion

func (client *SddcClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (SddcClient) UpdateSddc

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/UpdateSddc.go.html to see an example of how to use UpdateSddc API.

type SddcCollection

SddcCollection A list of SDDCs.

type SddcCollection struct {

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

func (SddcCollection) String

func (m SddcCollection) String() string

type SddcSummary

SddcSummary A summary of the SDDC.

type SddcSummary struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that
    // contains the SDDC.
    Id *string `mandatory:"true" json:"id"`

    // The availability domain that the SDDC's ESXi hosts are running in.
    ComputeAvailabilityDomain *string `mandatory:"true" json:"computeAvailabilityDomain"`

    // 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.cloud.oracle.com/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.
    EsxiHostsCount *int `mandatory:"true" json:"esxiHostsCount"`

    // 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.cloud.oracle.com/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.cloud.oracle.com/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 enabled or not
    IsHcxEnabled *bool `mandatory:"false" json:"isHcxEnabled"`

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

func (SddcSummary) String

func (m SddcSummary) String() string

type SortOrdersEnum

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 GetSortOrdersEnumValues

func GetSortOrdersEnumValues() []SortOrdersEnum

GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum

type SupportedVmwareSoftwareVersionCollection

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 (SupportedVmwareSoftwareVersionCollection) String

func (m SupportedVmwareSoftwareVersionCollection) String() string

type SupportedVmwareSoftwareVersionSummary

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

func (SupportedVmwareSoftwareVersionSummary) String

func (m SupportedVmwareSoftwareVersionSummary) String() string

type UpdateEsxiHostDetails

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 SDDC.
    // Avoid entering confidential information.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // 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.cloud.oracle.com/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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateEsxiHostDetails) String

func (m UpdateEsxiHostDetails) String() string

type UpdateEsxiHostRequest

UpdateEsxiHostRequest wrapper for the UpdateEsxiHost operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/UpdateEsxiHost.go.html to see an example of how to use UpdateEsxiHostRequest.

type UpdateEsxiHostRequest struct {

    // The OCID (https://docs.cloud.oracle.com/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 (UpdateEsxiHostRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateEsxiHostRequest) RetryPolicy

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

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

func (UpdateEsxiHostRequest) String

func (request UpdateEsxiHostRequest) String() string

type UpdateEsxiHostResponse

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 (UpdateEsxiHostResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateEsxiHostResponse) String

func (response UpdateEsxiHostResponse) String() string

type UpdateSddcDetails

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.cloud.oracle.com/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.
    // For the list of versions supported by the Oracle Cloud VMware Solution, see
    // ListSupportedVmwareSoftwareVersions).
    VmwareSoftwareVersion *string `mandatory:"false" json:"vmwareSoftwareVersion"`

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

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for
    // the vSphere component of the VMware environment when adding new ESXi hosts to the SDDC.
    VsphereVlanId *string `mandatory:"false" json:"vsphereVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for
    // the vMotion component of the VMware environment when adding new ESXi hosts to the SDDC.
    VmotionVlanId *string `mandatory:"false" json:"vmotionVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for
    // the vSAN component of the VMware environment when adding new ESXi hosts to the SDDC.
    VsanVlanId *string `mandatory:"false" json:"vsanVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for
    // the NSX VTEP component of the VMware environment when adding new ESXi hosts to the SDDC.
    NsxVTepVlanId *string `mandatory:"false" json:"nsxVTepVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for
    // the NSX Edge VTEP component of the VMware environment when adding new ESXi hosts to the SDDC.
    NsxEdgeVTepVlanId *string `mandatory:"false" json:"nsxEdgeVTepVlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for
    // the NSX Edge Uplink 1 component of the VMware environment when adding new ESXi hosts to the SDDC.
    NsxEdgeUplink1VlanId *string `mandatory:"false" json:"nsxEdgeUplink1VlanId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for
    // the NSX Edge Uplink 2 component of the VMware environment when adding new ESXi hosts to the SDDC.
    NsxEdgeUplink2VlanId *string `mandatory:"false" json:"nsxEdgeUplink2VlanId"`

    // This id is editable only when hcxEnabled is true
    HcxVlanId *string `mandatory:"false" json:"hcxVlanId"`

    // 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.cloud.oracle.com/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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateSddcDetails) String

func (m UpdateSddcDetails) String() string

type UpdateSddcRequest

UpdateSddcRequest wrapper for the UpdateSddc operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/UpdateSddc.go.html to see an example of how to use UpdateSddcRequest.

type UpdateSddcRequest struct {

    // The OCID (https://docs.cloud.oracle.com/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 (UpdateSddcRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateSddcRequest) RetryPolicy

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

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

func (UpdateSddcRequest) String

func (request UpdateSddcRequest) String() string

type UpdateSddcResponse

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 (UpdateSddcResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateSddcResponse) String

func (response UpdateSddcResponse) String() string

type WorkRequest

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.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    Id *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.cloud.oracle.com/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 (WorkRequest) String

func (m WorkRequest) String() string

type WorkRequestClient

WorkRequestClient a client for WorkRequest

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

func NewWorkRequestClientWithConfigurationProvider

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

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

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

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

func (WorkRequestClient) GetWorkRequest

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

GetWorkRequest Gets the specified work request's information.

See also

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

func (WorkRequestClient) ListWorkRequestErrors

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

ListWorkRequestErrors Lists the errors for the specified work request.

See also

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

func (WorkRequestClient) ListWorkRequestLogs

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

ListWorkRequestLogs Lists the logs for the specified work request.

See also

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

func (WorkRequestClient) ListWorkRequests

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

ListWorkRequests Lists the work requests in the specified compartment.

See also

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

func (*WorkRequestClient) SetRegion

func (client *WorkRequestClient) SetRegion(region string)

SetRegion overrides the region of this client.

type WorkRequestCollection

WorkRequestCollection A list of work requests.

type WorkRequestCollection struct {

    // A list of work requests.
    Items []WorkRequest `mandatory:"true" json:"items"`
}

func (WorkRequestCollection) String

func (m WorkRequestCollection) String() string

type WorkRequestError

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 (WorkRequestError) String

func (m WorkRequestError) String() string

type WorkRequestErrorCollection

WorkRequestErrorCollection A list of work request errors.

type WorkRequestErrorCollection struct {

    // A list of work request errors.
    Items []WorkRequestError `mandatory:"true" json:"items"`
}

func (WorkRequestErrorCollection) String

func (m WorkRequestErrorCollection) String() string

type WorkRequestLogEntry

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 (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

type WorkRequestLogEntryCollection

WorkRequestLogEntryCollection A list of work request logs.

type WorkRequestLogEntryCollection struct {

    // A list of work request logs.
    Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

func (WorkRequestLogEntryCollection) String

func (m WorkRequestLogEntryCollection) String() string

type WorkRequestResource

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.cloud.oracle.com/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 (WorkRequestResource) String

func (m WorkRequestResource) String() string