func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetCreateDesktopPoolDetailsUseDedicatedVmHostEnumStringValues() []string
GetCreateDesktopPoolDetailsUseDedicatedVmHostEnumStringValues Enumerates the set of values in String for CreateDesktopPoolDetailsUseDedicatedVmHostEnum
func GetCreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnumStringValues() []string
GetCreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnumStringValues Enumerates the set of values in String for CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum
func GetDesktopDevicePolicyAudioModeEnumStringValues() []string
GetDesktopDevicePolicyAudioModeEnumStringValues Enumerates the set of values in String for DesktopDevicePolicyAudioModeEnum
func GetDesktopDevicePolicyCdmModeEnumStringValues() []string
GetDesktopDevicePolicyCdmModeEnumStringValues Enumerates the set of values in String for DesktopDevicePolicyCdmModeEnum
func GetDesktopDevicePolicyClipboardModeEnumStringValues() []string
GetDesktopDevicePolicyClipboardModeEnumStringValues Enumerates the set of values in String for DesktopDevicePolicyClipboardModeEnum
func GetDesktopPoolShapeConfigBaselineOcpuUtilizationEnumStringValues() []string
GetDesktopPoolShapeConfigBaselineOcpuUtilizationEnumStringValues Enumerates the set of values in String for DesktopPoolShapeConfigBaselineOcpuUtilizationEnum
func GetDesktopPoolUseDedicatedVmHostEnumStringValues() []string
GetDesktopPoolUseDedicatedVmHostEnumStringValues Enumerates the set of values in String for DesktopPoolUseDedicatedVmHostEnum
func GetDesktopPoolVolumeSummaryLifecycleStateEnumStringValues() []string
GetDesktopPoolVolumeSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for DesktopPoolVolumeSummaryLifecycleStateEnum
func GetDisconnectConfigActionEnumStringValues() []string
GetDisconnectConfigActionEnumStringValues Enumerates the set of values in String for DisconnectConfigActionEnum
func GetInactivityConfigActionEnumStringValues() []string
GetInactivityConfigActionEnumStringValues Enumerates the set of values in String for InactivityConfigActionEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetListDesktopPoolDesktopsSortByEnumStringValues() []string
GetListDesktopPoolDesktopsSortByEnumStringValues Enumerates the set of values in String for ListDesktopPoolDesktopsSortByEnum
func GetListDesktopPoolDesktopsSortOrderEnumStringValues() []string
GetListDesktopPoolDesktopsSortOrderEnumStringValues Enumerates the set of values in String for ListDesktopPoolDesktopsSortOrderEnum
func GetListDesktopPoolVolumesSortByEnumStringValues() []string
GetListDesktopPoolVolumesSortByEnumStringValues Enumerates the set of values in String for ListDesktopPoolVolumesSortByEnum
func GetListDesktopPoolVolumesSortOrderEnumStringValues() []string
GetListDesktopPoolVolumesSortOrderEnumStringValues Enumerates the set of values in String for ListDesktopPoolVolumesSortOrderEnum
func GetListDesktopPoolsSortByEnumStringValues() []string
GetListDesktopPoolsSortByEnumStringValues Enumerates the set of values in String for ListDesktopPoolsSortByEnum
func GetListDesktopPoolsSortOrderEnumStringValues() []string
GetListDesktopPoolsSortOrderEnumStringValues Enumerates the set of values in String for ListDesktopPoolsSortOrderEnum
func GetListDesktopsSortByEnumStringValues() []string
GetListDesktopsSortByEnumStringValues Enumerates the set of values in String for ListDesktopsSortByEnum
func GetListDesktopsSortOrderEnumStringValues() []string
GetListDesktopsSortOrderEnumStringValues Enumerates the set of values in String for ListDesktopsSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// For optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
ChangeDesktopPoolCompartmentDetails Provides the OCID of the new compartment that will contain the desktop pool.
type ChangeDesktopPoolCompartmentDetails struct {
// The OCID of the compartment which will contain the desktop pool.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDesktopPoolCompartmentDetails) String() string
func (m ChangeDesktopPoolCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeDesktopPoolCompartmentRequest wrapper for the ChangeDesktopPoolCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ChangeDesktopPoolCompartment.go.html to see an example of how to use ChangeDesktopPoolCompartmentRequest.
type ChangeDesktopPoolCompartmentRequest struct {
// The OCID of the desktop pool.
DesktopPoolId *string `mandatory:"true" contributesTo:"path" name:"desktopPoolId"`
// The details of the new compartment of the desktop pool.
ChangeDesktopPoolCompartmentDetails `contributesTo:"body"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeDesktopPoolCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDesktopPoolCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDesktopPoolCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDesktopPoolCompartmentRequest) String() string
func (request ChangeDesktopPoolCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeDesktopPoolCompartmentResponse wrapper for the ChangeDesktopPoolCompartment operation
type ChangeDesktopPoolCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A unique identifier for an asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response ChangeDesktopPoolCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDesktopPoolCompartmentResponse) String() string
CreateDesktopPoolDesktopSessionLifecycleActions The details of action to be triggered in case of inactivity or disconnect
type CreateDesktopPoolDesktopSessionLifecycleActions struct {
Inactivity *InactivityConfig `mandatory:"false" json:"inactivity"`
Disconnect *DisconnectConfig `mandatory:"false" json:"disconnect"`
}
func (m CreateDesktopPoolDesktopSessionLifecycleActions) String() string
func (m CreateDesktopPoolDesktopSessionLifecycleActions) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDesktopPoolDetails Provides the configuration information used to create the desktop pool.
type CreateDesktopPoolDetails struct {
// The OCID of the compartment which will contain the desktop pool.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user friendly display name. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The maximum number of desktops permitted in the desktop pool.
MaximumSize *int `mandatory:"true" json:"maximumSize"`
// The maximum number of standby desktops available in the desktop pool.
StandbySize *int `mandatory:"true" json:"standbySize"`
// The shape of the desktop pool.
ShapeName *string `mandatory:"true" json:"shapeName"`
// Indicates whether storage is enabled for the desktop pool.
IsStorageEnabled *bool `mandatory:"true" json:"isStorageEnabled"`
// The size in GBs of the storage for the desktop pool.
StorageSizeInGBs *int `mandatory:"true" json:"storageSizeInGBs"`
// The backup policy OCID of the storage.
StorageBackupPolicyId *string `mandatory:"true" json:"storageBackupPolicyId"`
DevicePolicy *DesktopDevicePolicy `mandatory:"true" json:"devicePolicy"`
AvailabilityPolicy *DesktopAvailabilityPolicy `mandatory:"true" json:"availabilityPolicy"`
Image *DesktopImage `mandatory:"true" json:"image"`
NetworkConfiguration *DesktopNetworkConfiguration `mandatory:"true" json:"networkConfiguration"`
// Contact information of the desktop pool administrator.
// Avoid entering confidential information.
ContactDetails *string `mandatory:"true" json:"contactDetails"`
// Indicates whether desktop pool users have administrative privileges on their desktop.
ArePrivilegedUsers *bool `mandatory:"true" json:"arePrivilegedUsers"`
// The availability domain of the desktop pool.
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// A user friendly description providing additional information about the resource.
// Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
ShapeConfig *CreateDesktopPoolShapeConfigDetails `mandatory:"false" json:"shapeConfig"`
// Indicates whether the desktop pool uses dedicated virtual machine hosts.
UseDedicatedVmHost CreateDesktopPoolDetailsUseDedicatedVmHostEnum `mandatory:"false" json:"useDedicatedVmHost,omitempty"`
SessionLifecycleActions *CreateDesktopPoolDesktopSessionLifecycleActions `mandatory:"false" json:"sessionLifecycleActions"`
// The start time of the desktop pool.
TimeStartScheduled *common.SDKTime `mandatory:"false" json:"timeStartScheduled"`
// The stop time of the desktop pool.
TimeStopScheduled *common.SDKTime `mandatory:"false" json:"timeStopScheduled"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A list of network security groups for the private access.
NsgIds []string `mandatory:"false" json:"nsgIds"`
PrivateAccessDetails *CreateDesktopPoolPrivateAccessDetails `mandatory:"false" json:"privateAccessDetails"`
}
func (m CreateDesktopPoolDetails) String() string
func (m CreateDesktopPoolDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDesktopPoolDetailsUseDedicatedVmHostEnum Enum with underlying type: string
type CreateDesktopPoolDetailsUseDedicatedVmHostEnum string
Set of constants representing the allowable values for CreateDesktopPoolDetailsUseDedicatedVmHostEnum
const (
CreateDesktopPoolDetailsUseDedicatedVmHostTrue CreateDesktopPoolDetailsUseDedicatedVmHostEnum = "TRUE"
CreateDesktopPoolDetailsUseDedicatedVmHostFalse CreateDesktopPoolDetailsUseDedicatedVmHostEnum = "FALSE"
CreateDesktopPoolDetailsUseDedicatedVmHostAuto CreateDesktopPoolDetailsUseDedicatedVmHostEnum = "AUTO"
)
func GetCreateDesktopPoolDetailsUseDedicatedVmHostEnumValues() []CreateDesktopPoolDetailsUseDedicatedVmHostEnum
GetCreateDesktopPoolDetailsUseDedicatedVmHostEnumValues Enumerates the set of values for CreateDesktopPoolDetailsUseDedicatedVmHostEnum
func GetMappingCreateDesktopPoolDetailsUseDedicatedVmHostEnum(val string) (CreateDesktopPoolDetailsUseDedicatedVmHostEnum, bool)
GetMappingCreateDesktopPoolDetailsUseDedicatedVmHostEnum performs case Insensitive comparison on enum value and return the desired enum
CreateDesktopPoolPrivateAccessDetails The details of the desktop's private access network connectivity to be set up for the desktop pool.
type CreateDesktopPoolPrivateAccessDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the
// connectivity will be established.
SubnetId *string `mandatory:"true" json:"subnetId"`
// A list of network security groups for the private access.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The IPv4 address from the provided OCI subnet which needs to be assigned to the VNIC. If not provided, it will
// be auto-assigned with an available IPv4 address from the subnet.
PrivateIp *string `mandatory:"false" json:"privateIp"`
}
func (m CreateDesktopPoolPrivateAccessDetails) String() string
func (m CreateDesktopPoolPrivateAccessDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDesktopPoolRequest wrapper for the CreateDesktopPool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/CreateDesktopPool.go.html to see an example of how to use CreateDesktopPoolRequest.
type CreateDesktopPoolRequest struct {
// The details of the desktop pool to create.
CreateDesktopPoolDetails `contributesTo:"body"`
// A token that uniquely identifies a request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateDesktopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDesktopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDesktopPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDesktopPoolRequest) String() string
func (request CreateDesktopPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDesktopPoolResponse wrapper for the CreateDesktopPool operation
type CreateDesktopPoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The DesktopPool instance
DesktopPool `presentIn:"body"`
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A unique identifier for an asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A URL containing location of the newly created resource.
Location *string `presentIn:"header" name:"location"`
// A URL containing the location of the newly created resource.
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency. See if-match.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateDesktopPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDesktopPoolResponse) String() string
CreateDesktopPoolShapeConfigDetails The compute instance shape configuration requested for each desktop in the desktop pool.
type CreateDesktopPoolShapeConfigDetails struct {
// The total number of OCPUs available for each desktop compute instance in the desktop pool.
Ocpus *int64 `mandatory:"false" json:"ocpus"`
// The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool.
MemoryInGBs *int64 `mandatory:"false" json:"memoryInGBs"`
// The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in
// the desktop pool.
// Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with
// `BASELINE_1_1`.
//
// The following values are supported:
// - `BASELINE_1_8` - baseline usage is 1/8 of an OCPU.
// - `BASELINE_1_2` - baseline usage is 1/2 of an OCPU.
// - `BASELINE_1_1` - baseline usage is the entire OCPU. This represents a non-burstable instance.
BaselineOcpuUtilization CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum `mandatory:"false" json:"baselineOcpuUtilization,omitempty"`
}
func (m CreateDesktopPoolShapeConfigDetails) String() string
func (m CreateDesktopPoolShapeConfigDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum Enum with underlying type: string
type CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum string
Set of constants representing the allowable values for CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum
const (
CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilization8 CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum = "BASELINE_1_8"
CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilization2 CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum = "BASELINE_1_2"
CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilization1 CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum = "BASELINE_1_1"
)
func GetCreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnumValues() []CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum
GetCreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnumValues Enumerates the set of values for CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum
func GetMappingCreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum(val string) (CreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum, bool)
GetMappingCreateDesktopPoolShapeConfigDetailsBaselineOcpuUtilizationEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteDesktopPoolRequest wrapper for the DeleteDesktopPool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/DeleteDesktopPool.go.html to see an example of how to use DeleteDesktopPoolRequest.
type DeleteDesktopPoolRequest struct {
// The OCID of the desktop pool.
DesktopPoolId *string `mandatory:"true" contributesTo:"path" name:"desktopPoolId"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Whether the volumes are preserved when a desktop pool is deleted.
AreVolumesPreserved *bool `mandatory:"false" contributesTo:"query" name:"areVolumesPreserved"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteDesktopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDesktopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDesktopPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDesktopPoolRequest) String() string
func (request DeleteDesktopPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteDesktopPoolResponse wrapper for the DeleteDesktopPool operation
type DeleteDesktopPoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A unique identifier for an asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteDesktopPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDesktopPoolResponse) String() string
DeleteDesktopRequest wrapper for the DeleteDesktop operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/DeleteDesktop.go.html to see an example of how to use DeleteDesktopRequest.
type DeleteDesktopRequest struct {
// The OCID of the desktop.
DesktopId *string `mandatory:"true" contributesTo:"path" name:"desktopId"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteDesktopRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDesktopRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDesktopRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDesktopRequest) String() string
func (request DeleteDesktopRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteDesktopResponse wrapper for the DeleteDesktop operation
type DeleteDesktopResponse struct {
// The underlying http response
RawResponse *http.Response
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A unique identifier for an asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteDesktopResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDesktopResponse) String() string
Desktop Provides information about a desktop including name, state, id, configuration, owner, and time created.
type Desktop struct {
// The OCID of the desktop.
Id *string `mandatory:"true" json:"id"`
// The state of the desktop.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the resource was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user friendly display name. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
DevicePolicy *DesktopDevicePolicy `mandatory:"true" json:"devicePolicy"`
HostingOptions *HostingOptions `mandatory:"true" json:"hostingOptions"`
// The owner of the desktop.
UserName *string `mandatory:"true" json:"userName"`
// The OCID of the desktop pool the desktop is a member of.
PoolId *string `mandatory:"true" json:"poolId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Desktop) String() string
func (m Desktop) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopAvailabilityPolicy Provides the start and stop schedule information for desktop availability of the desktop pool.
type DesktopAvailabilityPolicy struct {
StartSchedule *DesktopSchedule `mandatory:"true" json:"startSchedule"`
StopSchedule *DesktopSchedule `mandatory:"true" json:"stopSchedule"`
}
func (m DesktopAvailabilityPolicy) String() string
func (m DesktopAvailabilityPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopCollection A list of desktops.
type DesktopCollection struct {
// A list of desktop summaries.
Items []DesktopSummary `mandatory:"true" json:"items"`
}
func (m DesktopCollection) String() string
func (m DesktopCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopDevicePolicy Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
type DesktopDevicePolicy struct {
// The clipboard mode.
// NONE: No access to the local clipboard is permitted.
// TODESKTOP: The clipboard can be used to transfer data to the desktop only.
// FROMDESKTOP: The clipboard can be used to transfer data from the desktop only.
// FULL: The clipboard can be used to transfer data to and from the desktop.
ClipboardMode DesktopDevicePolicyClipboardModeEnum `mandatory:"true" json:"clipboardMode"`
// The audio mode.
// NONE: No access to the local audio devices is permitted.
// TODESKTOP: The user may record audio on their desktop.
// FROMDESKTOP: The user may play audio on their desktop.
// FULL: The user may play and record audio on their desktop.
AudioMode DesktopDevicePolicyAudioModeEnum `mandatory:"true" json:"audioMode"`
// The client local drive access mode.
// NONE: No access to local drives permitted.
// READONLY: The user may read from local drives on their desktop.
// FULL: The user may read from and write to their local drives on their desktop.
CdmMode DesktopDevicePolicyCdmModeEnum `mandatory:"true" json:"cdmMode"`
// Indicates whether printing is enabled.
IsPrintingEnabled *bool `mandatory:"true" json:"isPrintingEnabled"`
// Indicates whether the pointer is enabled.
IsPointerEnabled *bool `mandatory:"true" json:"isPointerEnabled"`
// Indicates whether the keyboard is enabled.
IsKeyboardEnabled *bool `mandatory:"true" json:"isKeyboardEnabled"`
// Indicates whether the display is enabled.
IsDisplayEnabled *bool `mandatory:"true" json:"isDisplayEnabled"`
}
func (m DesktopDevicePolicy) String() string
func (m DesktopDevicePolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopDevicePolicyAudioModeEnum Enum with underlying type: string
type DesktopDevicePolicyAudioModeEnum string
Set of constants representing the allowable values for DesktopDevicePolicyAudioModeEnum
const (
DesktopDevicePolicyAudioModeNone DesktopDevicePolicyAudioModeEnum = "NONE"
DesktopDevicePolicyAudioModeTodesktop DesktopDevicePolicyAudioModeEnum = "TODESKTOP"
DesktopDevicePolicyAudioModeFromdesktop DesktopDevicePolicyAudioModeEnum = "FROMDESKTOP"
DesktopDevicePolicyAudioModeFull DesktopDevicePolicyAudioModeEnum = "FULL"
)
func GetDesktopDevicePolicyAudioModeEnumValues() []DesktopDevicePolicyAudioModeEnum
GetDesktopDevicePolicyAudioModeEnumValues Enumerates the set of values for DesktopDevicePolicyAudioModeEnum
func GetMappingDesktopDevicePolicyAudioModeEnum(val string) (DesktopDevicePolicyAudioModeEnum, bool)
GetMappingDesktopDevicePolicyAudioModeEnum performs case Insensitive comparison on enum value and return the desired enum
DesktopDevicePolicyCdmModeEnum Enum with underlying type: string
type DesktopDevicePolicyCdmModeEnum string
Set of constants representing the allowable values for DesktopDevicePolicyCdmModeEnum
const (
DesktopDevicePolicyCdmModeNone DesktopDevicePolicyCdmModeEnum = "NONE"
DesktopDevicePolicyCdmModeReadonly DesktopDevicePolicyCdmModeEnum = "READONLY"
DesktopDevicePolicyCdmModeFull DesktopDevicePolicyCdmModeEnum = "FULL"
)
func GetDesktopDevicePolicyCdmModeEnumValues() []DesktopDevicePolicyCdmModeEnum
GetDesktopDevicePolicyCdmModeEnumValues Enumerates the set of values for DesktopDevicePolicyCdmModeEnum
func GetMappingDesktopDevicePolicyCdmModeEnum(val string) (DesktopDevicePolicyCdmModeEnum, bool)
GetMappingDesktopDevicePolicyCdmModeEnum performs case Insensitive comparison on enum value and return the desired enum
DesktopDevicePolicyClipboardModeEnum Enum with underlying type: string
type DesktopDevicePolicyClipboardModeEnum string
Set of constants representing the allowable values for DesktopDevicePolicyClipboardModeEnum
const (
DesktopDevicePolicyClipboardModeNone DesktopDevicePolicyClipboardModeEnum = "NONE"
DesktopDevicePolicyClipboardModeTodesktop DesktopDevicePolicyClipboardModeEnum = "TODESKTOP"
DesktopDevicePolicyClipboardModeFromdesktop DesktopDevicePolicyClipboardModeEnum = "FROMDESKTOP"
DesktopDevicePolicyClipboardModeFull DesktopDevicePolicyClipboardModeEnum = "FULL"
)
func GetDesktopDevicePolicyClipboardModeEnumValues() []DesktopDevicePolicyClipboardModeEnum
GetDesktopDevicePolicyClipboardModeEnumValues Enumerates the set of values for DesktopDevicePolicyClipboardModeEnum
func GetMappingDesktopDevicePolicyClipboardModeEnum(val string) (DesktopDevicePolicyClipboardModeEnum, bool)
GetMappingDesktopDevicePolicyClipboardModeEnum performs case Insensitive comparison on enum value and return the desired enum
DesktopImage Provides information about the desktop image.
type DesktopImage struct {
// The OCID of the desktop image.
ImageId *string `mandatory:"true" json:"imageId"`
// The name of the desktop image.
ImageName *string `mandatory:"true" json:"imageName"`
// The operating system of the desktop image, e.g. "Oracle Linux", "Windows".
OperatingSystem *string `mandatory:"false" json:"operatingSystem"`
}
func (m DesktopImage) String() string
func (m DesktopImage) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopNetworkConfiguration Provides information about the network configuration of the desktop pool.
type DesktopNetworkConfiguration struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer VCN.
VcnId *string `mandatory:"true" json:"vcnId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the
// connectivity will be established.
SubnetId *string `mandatory:"true" json:"subnetId"`
}
func (m DesktopNetworkConfiguration) String() string
func (m DesktopNetworkConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopPool Provides information about a desktop pool including all configuration parameters.
type DesktopPool struct {
// The OCID of the desktop pool.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment of the desktop pool.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user friendly display name. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the desktop pool.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the resource was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The maximum number of desktops permitted in the desktop pool.
MaximumSize *int `mandatory:"true" json:"maximumSize"`
// The maximum number of standby desktops available in the desktop pool.
StandbySize *int `mandatory:"true" json:"standbySize"`
// The shape of the desktop pool.
ShapeName *string `mandatory:"true" json:"shapeName"`
// Indicates whether storage is enabled for the desktop pool.
IsStorageEnabled *bool `mandatory:"true" json:"isStorageEnabled"`
// The size in GBs of the storage for the desktop pool.
StorageSizeInGBs *int `mandatory:"true" json:"storageSizeInGBs"`
// The backup policy OCID of the storage.
StorageBackupPolicyId *string `mandatory:"true" json:"storageBackupPolicyId"`
DevicePolicy *DesktopDevicePolicy `mandatory:"true" json:"devicePolicy"`
AvailabilityPolicy *DesktopAvailabilityPolicy `mandatory:"true" json:"availabilityPolicy"`
Image *DesktopImage `mandatory:"true" json:"image"`
NetworkConfiguration *DesktopNetworkConfiguration `mandatory:"true" json:"networkConfiguration"`
// Contact information of the desktop pool administrator.
// Avoid entering confidential information.
ContactDetails *string `mandatory:"true" json:"contactDetails"`
// Indicates whether desktop pool users have administrative privileges on their desktop.
ArePrivilegedUsers *bool `mandatory:"true" json:"arePrivilegedUsers"`
// The availability domain of the desktop pool.
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// A user friendly description providing additional information about the resource.
// Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
ShapeConfig *DesktopPoolShapeConfig `mandatory:"false" json:"shapeConfig"`
// Indicates whether the desktop pool uses dedicated virtual machine hosts.
UseDedicatedVmHost DesktopPoolUseDedicatedVmHostEnum `mandatory:"false" json:"useDedicatedVmHost,omitempty"`
SessionLifecycleActions *DesktopSessionLifecycleActions `mandatory:"false" json:"sessionLifecycleActions"`
// The start time of the desktop pool.
TimeStartScheduled *common.SDKTime `mandatory:"false" json:"timeStartScheduled"`
// The stop time of the desktop pool.
TimeStopScheduled *common.SDKTime `mandatory:"false" json:"timeStopScheduled"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A list of network security groups for the network.
NsgIds []string `mandatory:"false" json:"nsgIds"`
PrivateAccessDetails *DesktopPoolPrivateAccessDetails `mandatory:"false" json:"privateAccessDetails"`
}
func (m DesktopPool) String() string
func (m DesktopPool) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopPoolCollection A list of desktop pools.
type DesktopPoolCollection struct {
// A list of desktop pool summaries.
Items []DesktopPoolSummary `mandatory:"true" json:"items"`
}
func (m DesktopPoolCollection) String() string
func (m DesktopPoolCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopPoolDesktopCollection A list of desktops within a desktop pool.
type DesktopPoolDesktopCollection struct {
// A list of desktops.
Items []DesktopPoolDesktopSummary `mandatory:"true" json:"items"`
}
func (m DesktopPoolDesktopCollection) String() string
func (m DesktopPoolDesktopCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopPoolDesktopSummary Provides information about a desktop within a desktop pool, such as if it is assigned to a user, the state, owner, desktop pool, resource id, and time created.
type DesktopPoolDesktopSummary struct {
// The state of the desktop.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID of the compute resource used by this desktop.
InstanceId *string `mandatory:"true" json:"instanceId"`
// The OCID of the desktop.
DesktopId *string `mandatory:"true" json:"desktopId"`
// Indicates whether the desktop is assigned to a user.
IsAssigned *bool `mandatory:"true" json:"isAssigned"`
// The date and time the resource was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The owner of the desktop.
UserName *string `mandatory:"false" json:"userName"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m DesktopPoolDesktopSummary) String() string
func (m DesktopPoolDesktopSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopPoolPrivateAccessDetails The details of the desktop's private access network connectivity that were used to create the pool.
type DesktopPoolPrivateAccessDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the
// connectivity will be established.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer VCN.
VcnId *string `mandatory:"true" json:"vcnId"`
// A list of network security groups for the private access.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The IPv4 address from the provided OCI subnet which needs to be assigned to the VNIC. If not provided, it will
// be auto-assigned with an available IPv4 address from the subnet.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The three-label FQDN to use for the private endpoint. The customer VCN's DNS records are
// updated with this FQDN. This enables the customer to use the FQDN instead of the private endpoint's
// private IP address to access the service (for example, xyz.oraclecloud.com).
EndpointFqdn *string `mandatory:"false" json:"endpointFqdn"`
}
func (m DesktopPoolPrivateAccessDetails) String() string
func (m DesktopPoolPrivateAccessDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopPoolShapeConfig The shape configuration used for each desktop compute instance in the desktop pool.
type DesktopPoolShapeConfig struct {
// The total number of OCPUs available for each desktop compute instance in the desktop pool.
Ocpus *int64 `mandatory:"false" json:"ocpus"`
// The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool.
MemoryInGBs *int64 `mandatory:"false" json:"memoryInGBs"`
// The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in
// the desktop pool.
// Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with
// `BASELINE_1_1`.
//
// The following values are supported:
// - `BASELINE_1_8` - baseline usage is 1/8 of an OCPU.
// - `BASELINE_1_2` - baseline usage is 1/2 of an OCPU.
// - `BASELINE_1_1` - baseline usage is the entire OCPU. This represents a non-burstable instance.
BaselineOcpuUtilization DesktopPoolShapeConfigBaselineOcpuUtilizationEnum `mandatory:"false" json:"baselineOcpuUtilization,omitempty"`
}
func (m DesktopPoolShapeConfig) String() string
func (m DesktopPoolShapeConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopPoolShapeConfigBaselineOcpuUtilizationEnum Enum with underlying type: string
type DesktopPoolShapeConfigBaselineOcpuUtilizationEnum string
Set of constants representing the allowable values for DesktopPoolShapeConfigBaselineOcpuUtilizationEnum
const (
DesktopPoolShapeConfigBaselineOcpuUtilization8 DesktopPoolShapeConfigBaselineOcpuUtilizationEnum = "BASELINE_1_8"
DesktopPoolShapeConfigBaselineOcpuUtilization2 DesktopPoolShapeConfigBaselineOcpuUtilizationEnum = "BASELINE_1_2"
DesktopPoolShapeConfigBaselineOcpuUtilization1 DesktopPoolShapeConfigBaselineOcpuUtilizationEnum = "BASELINE_1_1"
)
func GetDesktopPoolShapeConfigBaselineOcpuUtilizationEnumValues() []DesktopPoolShapeConfigBaselineOcpuUtilizationEnum
GetDesktopPoolShapeConfigBaselineOcpuUtilizationEnumValues Enumerates the set of values for DesktopPoolShapeConfigBaselineOcpuUtilizationEnum
func GetMappingDesktopPoolShapeConfigBaselineOcpuUtilizationEnum(val string) (DesktopPoolShapeConfigBaselineOcpuUtilizationEnum, bool)
GetMappingDesktopPoolShapeConfigBaselineOcpuUtilizationEnum performs case Insensitive comparison on enum value and return the desired enum
DesktopPoolSummary Provides information about the desktop pool such as number of active desktops, name, OCID, state, and maximum size.
type DesktopPoolSummary struct {
// The OCID of the desktop pool.
Id *string `mandatory:"true" json:"id"`
// A user friendly display name. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the desktop pool.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The maximum number of desktops permitted in the desktop pool.
MaximumSize *int `mandatory:"true" json:"maximumSize"`
// Contact information of the desktop pool administrator.
// Avoid entering confidential information.
ContactDetails *string `mandatory:"true" json:"contactDetails"`
// The OCID of the compartment which will contain the desktop pool.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the resource was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The number of active desktops in the desktop pool.
ActiveDesktops *int `mandatory:"false" json:"activeDesktops"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m DesktopPoolSummary) String() string
func (m DesktopPoolSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopPoolUseDedicatedVmHostEnum Enum with underlying type: string
type DesktopPoolUseDedicatedVmHostEnum string
Set of constants representing the allowable values for DesktopPoolUseDedicatedVmHostEnum
const (
DesktopPoolUseDedicatedVmHostTrue DesktopPoolUseDedicatedVmHostEnum = "TRUE"
DesktopPoolUseDedicatedVmHostFalse DesktopPoolUseDedicatedVmHostEnum = "FALSE"
DesktopPoolUseDedicatedVmHostAuto DesktopPoolUseDedicatedVmHostEnum = "AUTO"
)
func GetDesktopPoolUseDedicatedVmHostEnumValues() []DesktopPoolUseDedicatedVmHostEnum
GetDesktopPoolUseDedicatedVmHostEnumValues Enumerates the set of values for DesktopPoolUseDedicatedVmHostEnum
func GetMappingDesktopPoolUseDedicatedVmHostEnum(val string) (DesktopPoolUseDedicatedVmHostEnum, bool)
GetMappingDesktopPoolUseDedicatedVmHostEnum performs case Insensitive comparison on enum value and return the desired enum
DesktopPoolVolumeCollection A list of volumes within a desktop pool.
type DesktopPoolVolumeCollection struct {
// A list of desktop pool volumes.
Items []DesktopPoolVolumeSummary `mandatory:"true" json:"items"`
}
func (m DesktopPoolVolumeCollection) String() string
func (m DesktopPoolVolumeCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopPoolVolumeSummary Provides information about a volume within the desktop pool.
type DesktopPoolVolumeSummary struct {
// The OCID of the desktop pool volume.
Id *string `mandatory:"true" json:"id"`
// The name of the desktop pool volume.
Name *string `mandatory:"true" json:"name"`
// The state of the desktop pool volume.
LifecycleState DesktopPoolVolumeSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The owner of the desktop pool volume.
UserName *string `mandatory:"true" json:"userName"`
// The availability domain of the desktop pool.
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The OCID of the desktop pool to which this volume belongs.
PoolId *string `mandatory:"false" json:"poolId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m DesktopPoolVolumeSummary) String() string
func (m DesktopPoolVolumeSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopPoolVolumeSummaryLifecycleStateEnum Enum with underlying type: string
type DesktopPoolVolumeSummaryLifecycleStateEnum string
Set of constants representing the allowable values for DesktopPoolVolumeSummaryLifecycleStateEnum
const (
DesktopPoolVolumeSummaryLifecycleStateActive DesktopPoolVolumeSummaryLifecycleStateEnum = "ACTIVE"
DesktopPoolVolumeSummaryLifecycleStateInactive DesktopPoolVolumeSummaryLifecycleStateEnum = "INACTIVE"
)
func GetDesktopPoolVolumeSummaryLifecycleStateEnumValues() []DesktopPoolVolumeSummaryLifecycleStateEnum
GetDesktopPoolVolumeSummaryLifecycleStateEnumValues Enumerates the set of values for DesktopPoolVolumeSummaryLifecycleStateEnum
func GetMappingDesktopPoolVolumeSummaryLifecycleStateEnum(val string) (DesktopPoolVolumeSummaryLifecycleStateEnum, bool)
GetMappingDesktopPoolVolumeSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DesktopSchedule Provides the schedule information for a desktop.
type DesktopSchedule struct {
// A cron expression describing the desktop's schedule.
CronExpression *string `mandatory:"true" json:"cronExpression"`
// The timezone of the desktop's schedule.
Timezone *string `mandatory:"true" json:"timezone"`
}
func (m DesktopSchedule) String() string
func (m DesktopSchedule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopServiceClient a client for DesktopService
type DesktopServiceClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewDesktopServiceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DesktopServiceClient, err error)
NewDesktopServiceClientWithConfigurationProvider Creates a new default DesktopService client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDesktopServiceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DesktopServiceClient, err error)
NewDesktopServiceClientWithOboToken Creates a new default DesktopService client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client DesktopServiceClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancel work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()
func (client DesktopServiceClient) ChangeDesktopPoolCompartment(ctx context.Context, request ChangeDesktopPoolCompartmentRequest) (response ChangeDesktopPoolCompartmentResponse, err error)
ChangeDesktopPoolCompartment Moves a desktop pool into a different compartment within the same tenancy. You must provide the OCID of the desktop pool and the OCID of the compartment that you are moving the pool to.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ChangeDesktopPoolCompartment.go.html to see an example of how to use ChangeDesktopPoolCompartment API. A default retry strategy applies to this operation ChangeDesktopPoolCompartment()
func (client *DesktopServiceClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DesktopServiceClient) CreateDesktopPool(ctx context.Context, request CreateDesktopPoolRequest) (response CreateDesktopPoolResponse, err error)
CreateDesktopPool Creates a desktop pool with the given configuration parameters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/CreateDesktopPool.go.html to see an example of how to use CreateDesktopPool API. A default retry strategy applies to this operation CreateDesktopPool()
func (client DesktopServiceClient) DeleteDesktop(ctx context.Context, request DeleteDesktopRequest) (response DeleteDesktopResponse, err error)
DeleteDesktop Deletes the desktop with the specified OCID. The service terminates the associated compute instance. The end-user loses access to the desktop instance permanently. Any associated block volume becomes inactive but is not deleted.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/DeleteDesktop.go.html to see an example of how to use DeleteDesktop API. A default retry strategy applies to this operation DeleteDesktop()
func (client DesktopServiceClient) DeleteDesktopPool(ctx context.Context, request DeleteDesktopPoolRequest) (response DeleteDesktopPoolResponse, err error)
DeleteDesktopPool Deletes a desktop pool with the specified OCID. The service terminates all compute instances and users immediately lose access to their desktops. You can choose to preserve the block volumes associated with the pool.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/DeleteDesktopPool.go.html to see an example of how to use DeleteDesktopPool API. A default retry strategy applies to this operation DeleteDesktopPool()
func (client DesktopServiceClient) GetDesktop(ctx context.Context, request GetDesktopRequest) (response GetDesktopResponse, err error)
GetDesktop Provides information about the desktop with the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/GetDesktop.go.html to see an example of how to use GetDesktop API. A default retry strategy applies to this operation GetDesktop()
func (client DesktopServiceClient) GetDesktopPool(ctx context.Context, request GetDesktopPoolRequest) (response GetDesktopPoolResponse, err error)
GetDesktopPool Returns information about the desktop pool including all configuration parameters and the current state.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/GetDesktopPool.go.html to see an example of how to use GetDesktopPool API. A default retry strategy applies to this operation GetDesktopPool()
func (client DesktopServiceClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client DesktopServiceClient) ListDesktopPoolDesktops(ctx context.Context, request ListDesktopPoolDesktopsRequest) (response ListDesktopPoolDesktopsResponse, err error)
ListDesktopPoolDesktops Returns a list of desktops within a given desktop pool. You can limit the results to an availability domain, desktop name, or desktop state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListDesktopPoolDesktops.go.html to see an example of how to use ListDesktopPoolDesktops API. A default retry strategy applies to this operation ListDesktopPoolDesktops()
func (client DesktopServiceClient) ListDesktopPoolVolumes(ctx context.Context, request ListDesktopPoolVolumesRequest) (response ListDesktopPoolVolumesResponse, err error)
ListDesktopPoolVolumes Returns a list of volumes within the given desktop pool. You can limit the results to an availability domain, volume name, or volume state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListDesktopPoolVolumes.go.html to see an example of how to use ListDesktopPoolVolumes API. A default retry strategy applies to this operation ListDesktopPoolVolumes()
func (client DesktopServiceClient) ListDesktopPools(ctx context.Context, request ListDesktopPoolsRequest) (response ListDesktopPoolsResponse, err error)
ListDesktopPools Returns a list of desktop pools within the given compartment. You can limit the results to an availability domain, pool name, or pool state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListDesktopPools.go.html to see an example of how to use ListDesktopPools API. A default retry strategy applies to this operation ListDesktopPools()
func (client DesktopServiceClient) ListDesktops(ctx context.Context, request ListDesktopsRequest) (response ListDesktopsResponse, err error)
ListDesktops Returns a list of desktops filtered by the specified parameters. You can limit the results to an availability domain, desktop name, desktop OCID, desktop state, pool OCID, or compartment OCID. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListDesktops.go.html to see an example of how to use ListDesktops API. A default retry strategy applies to this operation ListDesktops()
func (client DesktopServiceClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Return a (paginated) list of errors for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client DesktopServiceClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Return a (paginated) list of logs for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client DesktopServiceClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *DesktopServiceClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DesktopServiceClient) StartDesktop(ctx context.Context, request StartDesktopRequest) (response StartDesktopResponse, err error)
StartDesktop Starts the desktop with the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/StartDesktop.go.html to see an example of how to use StartDesktop API. A default retry strategy applies to this operation StartDesktop()
func (client DesktopServiceClient) StartDesktopPool(ctx context.Context, request StartDesktopPoolRequest) (response StartDesktopPoolResponse, err error)
StartDesktopPool Starts the desktop pool with the specified OCID. Once the pool is ACTIVE, users will have access to their desktops within the pool.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/StartDesktopPool.go.html to see an example of how to use StartDesktopPool API. A default retry strategy applies to this operation StartDesktopPool()
func (client DesktopServiceClient) StopDesktop(ctx context.Context, request StopDesktopRequest) (response StopDesktopResponse, err error)
StopDesktop Stops the desktop with the specified OCID. Stopping a desktop causes the end-user to lose access to their desktop instance until the desktop is restarted.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/StopDesktop.go.html to see an example of how to use StopDesktop API. A default retry strategy applies to this operation StopDesktop()
func (client DesktopServiceClient) StopDesktopPool(ctx context.Context, request StopDesktopPoolRequest) (response StopDesktopPoolResponse, err error)
StopDesktopPool Stops the desktop pool with the specified OCID. Users will lose access to their desktops until you explicitly start the pool again.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/StopDesktopPool.go.html to see an example of how to use StopDesktopPool API. A default retry strategy applies to this operation StopDesktopPool()
func (client DesktopServiceClient) UpdateDesktop(ctx context.Context, request UpdateDesktopRequest) (response UpdateDesktopResponse, err error)
UpdateDesktop Modifies information about the desktop such as the name.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/UpdateDesktop.go.html to see an example of how to use UpdateDesktop API. A default retry strategy applies to this operation UpdateDesktop()
func (client DesktopServiceClient) UpdateDesktopPool(ctx context.Context, request UpdateDesktopPoolRequest) (response UpdateDesktopPoolResponse, err error)
UpdateDesktopPool Modifies the configuration of the desktop pool such as the availability, contact information, description, name, device policy, pool size, standby size, and start or stop time.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/UpdateDesktopPool.go.html to see an example of how to use UpdateDesktopPool API. A default retry strategy applies to this operation UpdateDesktopPool()
DesktopSessionLifecycleActions Action to be triggered on inactivity or disconnect
type DesktopSessionLifecycleActions struct {
Inactivity *InactivityConfig `mandatory:"false" json:"inactivity"`
Disconnect *DisconnectConfig `mandatory:"false" json:"disconnect"`
}
func (m DesktopSessionLifecycleActions) String() string
func (m DesktopSessionLifecycleActions) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DesktopSummary Provides information about a desktop.
type DesktopSummary struct {
// The OCID of the desktop.
Id *string `mandatory:"true" json:"id"`
// The state of the desktop.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the resource was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user friendly display name. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The owner of the desktop.
UserName *string `mandatory:"true" json:"userName"`
// The pool ID of the desktop.
PoolId *string `mandatory:"true" json:"poolId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m DesktopSummary) String() string
func (m DesktopSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DisconnectConfig Action and grace period for disconnect
type DisconnectConfig struct {
// a disconnect action to be triggered
Action DisconnectConfigActionEnum `mandatory:"true" json:"action"`
// The period of time (in minutes) after disconnect before any action occurs.
// If the value is not provided, a default value is used.
GracePeriodInMinutes *int `mandatory:"false" json:"gracePeriodInMinutes"`
}
func (m DisconnectConfig) String() string
func (m DisconnectConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DisconnectConfigActionEnum Enum with underlying type: string
type DisconnectConfigActionEnum string
Set of constants representing the allowable values for DisconnectConfigActionEnum
const (
DisconnectConfigActionNone DisconnectConfigActionEnum = "NONE"
DisconnectConfigActionStop DisconnectConfigActionEnum = "STOP"
)
func GetDisconnectConfigActionEnumValues() []DisconnectConfigActionEnum
GetDisconnectConfigActionEnumValues Enumerates the set of values for DisconnectConfigActionEnum
func GetMappingDisconnectConfigActionEnum(val string) (DisconnectConfigActionEnum, bool)
GetMappingDisconnectConfigActionEnum performs case Insensitive comparison on enum value and return the desired enum
GetDesktopPoolRequest wrapper for the GetDesktopPool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/GetDesktopPool.go.html to see an example of how to use GetDesktopPoolRequest.
type GetDesktopPoolRequest struct {
// The OCID of the desktop pool.
DesktopPoolId *string `mandatory:"true" contributesTo:"path" name:"desktopPoolId"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetDesktopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDesktopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDesktopPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDesktopPoolRequest) String() string
func (request GetDesktopPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetDesktopPoolResponse wrapper for the GetDesktopPool operation
type GetDesktopPoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The DesktopPool instance
DesktopPool `presentIn:"body"`
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency. See if-match.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetDesktopPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDesktopPoolResponse) String() string
GetDesktopRequest wrapper for the GetDesktop operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/GetDesktop.go.html to see an example of how to use GetDesktopRequest.
type GetDesktopRequest struct {
// The OCID of the desktop.
DesktopId *string `mandatory:"true" contributesTo:"path" name:"desktopId"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetDesktopRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDesktopRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDesktopRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDesktopRequest) String() string
func (request GetDesktopRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetDesktopResponse wrapper for the GetDesktop operation
type GetDesktopResponse struct {
// The underlying http response
RawResponse *http.Response
// The Desktop instance
Desktop `presentIn:"body"`
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency. See if-match.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetDesktopResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDesktopResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency. See if-match.
Etag *string `presentIn:"header" name:"etag"`
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HostingOptions Provides information about where a desktop is hosted.
type HostingOptions struct {
Image *DesktopImage `mandatory:"true" json:"image"`
// The connection address of the desktop.
ConnectAddress *string `mandatory:"true" json:"connectAddress"`
}
func (m HostingOptions) String() string
func (m HostingOptions) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InactivityConfig Action and grace period for inactivity
type InactivityConfig struct {
// an inactivity action to be triggered
Action InactivityConfigActionEnum `mandatory:"true" json:"action"`
// The period of time (in minutes) during which the session must remain inactive before any action occurs.
// If the value is not provided, a default value is used.
GracePeriodInMinutes *int `mandatory:"false" json:"gracePeriodInMinutes"`
}
func (m InactivityConfig) String() string
func (m InactivityConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InactivityConfigActionEnum Enum with underlying type: string
type InactivityConfigActionEnum string
Set of constants representing the allowable values for InactivityConfigActionEnum
const (
InactivityConfigActionNone InactivityConfigActionEnum = "NONE"
InactivityConfigActionDisconnect InactivityConfigActionEnum = "DISCONNECT"
)
func GetInactivityConfigActionEnumValues() []InactivityConfigActionEnum
GetInactivityConfigActionEnumValues Enumerates the set of values for InactivityConfigActionEnum
func GetMappingInactivityConfigActionEnum(val string) (InactivityConfigActionEnum, bool)
GetMappingInactivityConfigActionEnum performs case Insensitive comparison on enum value and return the desired enum
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum
const (
LifecycleStateCreating LifecycleStateEnum = "CREATING"
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateInactive LifecycleStateEnum = "INACTIVE"
LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
LifecycleStateDeleting LifecycleStateEnum = "DELETING"
LifecycleStateDeleted LifecycleStateEnum = "DELETED"
LifecycleStateFailed LifecycleStateEnum = "FAILED"
)
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDesktopPoolDesktopsRequest wrapper for the ListDesktopPoolDesktops operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListDesktopPoolDesktops.go.html to see an example of how to use ListDesktopPoolDesktopsRequest.
type ListDesktopPoolDesktopsRequest struct {
// The OCID of the compartment of the desktop pool.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID of the desktop pool.
DesktopPoolId *string `mandatory:"true" contributesTo:"path" name:"desktopPoolId"`
// The name of the availability domain.
AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`
// A filter to return only results with the given displayName.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only results with the given OCID.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only results with the given lifecycleState.
LifecycleState *string `mandatory:"false" contributesTo:"query" name:"lifecycleState"`
// The maximum number of results to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A field to sort by.
SortBy ListDesktopPoolDesktopsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A field to indicate the sort order.
SortOrder ListDesktopPoolDesktopsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDesktopPoolDesktopsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDesktopPoolDesktopsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDesktopPoolDesktopsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDesktopPoolDesktopsRequest) String() string
func (request ListDesktopPoolDesktopsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDesktopPoolDesktopsResponse wrapper for the ListDesktopPoolDesktops operation
type ListDesktopPoolDesktopsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DesktopPoolDesktopCollection instances
DesktopPoolDesktopCollection `presentIn:"body"`
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDesktopPoolDesktopsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDesktopPoolDesktopsResponse) String() string
ListDesktopPoolDesktopsSortByEnum Enum with underlying type: string
type ListDesktopPoolDesktopsSortByEnum string
Set of constants representing the allowable values for ListDesktopPoolDesktopsSortByEnum
const (
ListDesktopPoolDesktopsSortByTimecreated ListDesktopPoolDesktopsSortByEnum = "TIMECREATED"
ListDesktopPoolDesktopsSortByDisplayname ListDesktopPoolDesktopsSortByEnum = "DISPLAYNAME"
)
func GetListDesktopPoolDesktopsSortByEnumValues() []ListDesktopPoolDesktopsSortByEnum
GetListDesktopPoolDesktopsSortByEnumValues Enumerates the set of values for ListDesktopPoolDesktopsSortByEnum
func GetMappingListDesktopPoolDesktopsSortByEnum(val string) (ListDesktopPoolDesktopsSortByEnum, bool)
GetMappingListDesktopPoolDesktopsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDesktopPoolDesktopsSortOrderEnum Enum with underlying type: string
type ListDesktopPoolDesktopsSortOrderEnum string
Set of constants representing the allowable values for ListDesktopPoolDesktopsSortOrderEnum
const (
ListDesktopPoolDesktopsSortOrderAsc ListDesktopPoolDesktopsSortOrderEnum = "ASC"
ListDesktopPoolDesktopsSortOrderDesc ListDesktopPoolDesktopsSortOrderEnum = "DESC"
)
func GetListDesktopPoolDesktopsSortOrderEnumValues() []ListDesktopPoolDesktopsSortOrderEnum
GetListDesktopPoolDesktopsSortOrderEnumValues Enumerates the set of values for ListDesktopPoolDesktopsSortOrderEnum
func GetMappingListDesktopPoolDesktopsSortOrderEnum(val string) (ListDesktopPoolDesktopsSortOrderEnum, bool)
GetMappingListDesktopPoolDesktopsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDesktopPoolVolumesRequest wrapper for the ListDesktopPoolVolumes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListDesktopPoolVolumes.go.html to see an example of how to use ListDesktopPoolVolumesRequest.
type ListDesktopPoolVolumesRequest struct {
// The OCID of the desktop pool.
DesktopPoolId *string `mandatory:"true" contributesTo:"path" name:"desktopPoolId"`
// The OCID of the compartment of the desktop pool.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the availability domain.
AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`
// A filter to return only results with the given displayName.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only results with the given OCID.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only results with the given lifecycleState.
LifecycleState *string `mandatory:"false" contributesTo:"query" name:"lifecycleState"`
// The maximum number of results to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A field to sort by.
SortBy ListDesktopPoolVolumesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A field to indicate the sort order.
SortOrder ListDesktopPoolVolumesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDesktopPoolVolumesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDesktopPoolVolumesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDesktopPoolVolumesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDesktopPoolVolumesRequest) String() string
func (request ListDesktopPoolVolumesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDesktopPoolVolumesResponse wrapper for the ListDesktopPoolVolumes operation
type ListDesktopPoolVolumesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DesktopPoolVolumeCollection instances
DesktopPoolVolumeCollection `presentIn:"body"`
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDesktopPoolVolumesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDesktopPoolVolumesResponse) String() string
ListDesktopPoolVolumesSortByEnum Enum with underlying type: string
type ListDesktopPoolVolumesSortByEnum string
Set of constants representing the allowable values for ListDesktopPoolVolumesSortByEnum
const (
ListDesktopPoolVolumesSortByTimecreated ListDesktopPoolVolumesSortByEnum = "TIMECREATED"
ListDesktopPoolVolumesSortByDisplayname ListDesktopPoolVolumesSortByEnum = "DISPLAYNAME"
)
func GetListDesktopPoolVolumesSortByEnumValues() []ListDesktopPoolVolumesSortByEnum
GetListDesktopPoolVolumesSortByEnumValues Enumerates the set of values for ListDesktopPoolVolumesSortByEnum
func GetMappingListDesktopPoolVolumesSortByEnum(val string) (ListDesktopPoolVolumesSortByEnum, bool)
GetMappingListDesktopPoolVolumesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDesktopPoolVolumesSortOrderEnum Enum with underlying type: string
type ListDesktopPoolVolumesSortOrderEnum string
Set of constants representing the allowable values for ListDesktopPoolVolumesSortOrderEnum
const (
ListDesktopPoolVolumesSortOrderAsc ListDesktopPoolVolumesSortOrderEnum = "ASC"
ListDesktopPoolVolumesSortOrderDesc ListDesktopPoolVolumesSortOrderEnum = "DESC"
)
func GetListDesktopPoolVolumesSortOrderEnumValues() []ListDesktopPoolVolumesSortOrderEnum
GetListDesktopPoolVolumesSortOrderEnumValues Enumerates the set of values for ListDesktopPoolVolumesSortOrderEnum
func GetMappingListDesktopPoolVolumesSortOrderEnum(val string) (ListDesktopPoolVolumesSortOrderEnum, bool)
GetMappingListDesktopPoolVolumesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDesktopPoolsRequest wrapper for the ListDesktopPools operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListDesktopPools.go.html to see an example of how to use ListDesktopPoolsRequest.
type ListDesktopPoolsRequest struct {
// The OCID of the compartment of the desktop pool.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the availability domain.
AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`
// A filter to return only results with the given displayName.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only results with the given OCID.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only results with the given lifecycleState.
LifecycleState *string `mandatory:"false" contributesTo:"query" name:"lifecycleState"`
// The maximum number of results to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A field to sort by.
SortBy ListDesktopPoolsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A field to indicate the sort order.
SortOrder ListDesktopPoolsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDesktopPoolsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDesktopPoolsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDesktopPoolsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDesktopPoolsRequest) String() string
func (request ListDesktopPoolsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDesktopPoolsResponse wrapper for the ListDesktopPools operation
type ListDesktopPoolsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DesktopPoolCollection instances
DesktopPoolCollection `presentIn:"body"`
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDesktopPoolsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDesktopPoolsResponse) String() string
ListDesktopPoolsSortByEnum Enum with underlying type: string
type ListDesktopPoolsSortByEnum string
Set of constants representing the allowable values for ListDesktopPoolsSortByEnum
const (
ListDesktopPoolsSortByTimecreated ListDesktopPoolsSortByEnum = "TIMECREATED"
ListDesktopPoolsSortByDisplayname ListDesktopPoolsSortByEnum = "DISPLAYNAME"
)
func GetListDesktopPoolsSortByEnumValues() []ListDesktopPoolsSortByEnum
GetListDesktopPoolsSortByEnumValues Enumerates the set of values for ListDesktopPoolsSortByEnum
func GetMappingListDesktopPoolsSortByEnum(val string) (ListDesktopPoolsSortByEnum, bool)
GetMappingListDesktopPoolsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDesktopPoolsSortOrderEnum Enum with underlying type: string
type ListDesktopPoolsSortOrderEnum string
Set of constants representing the allowable values for ListDesktopPoolsSortOrderEnum
const (
ListDesktopPoolsSortOrderAsc ListDesktopPoolsSortOrderEnum = "ASC"
ListDesktopPoolsSortOrderDesc ListDesktopPoolsSortOrderEnum = "DESC"
)
func GetListDesktopPoolsSortOrderEnumValues() []ListDesktopPoolsSortOrderEnum
GetListDesktopPoolsSortOrderEnumValues Enumerates the set of values for ListDesktopPoolsSortOrderEnum
func GetMappingListDesktopPoolsSortOrderEnum(val string) (ListDesktopPoolsSortOrderEnum, bool)
GetMappingListDesktopPoolsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDesktopsRequest wrapper for the ListDesktops operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListDesktops.go.html to see an example of how to use ListDesktopsRequest.
type ListDesktopsRequest struct {
// The OCID of the compartment of the desktop pool.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the availability domain.
AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`
// A filter to return only results with the given displayName.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only results with the given OCID.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only results with the given lifecycleState.
LifecycleState *string `mandatory:"false" contributesTo:"query" name:"lifecycleState"`
// The maximum number of results to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A field to sort by.
SortBy ListDesktopsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A field to indicate the sort order.
SortOrder ListDesktopsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The OCID of the desktop pool.
DesktopPoolId *string `mandatory:"false" contributesTo:"query" name:"desktopPoolId"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDesktopsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDesktopsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDesktopsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDesktopsRequest) String() string
func (request ListDesktopsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDesktopsResponse wrapper for the ListDesktops operation
type ListDesktopsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DesktopCollection instances
DesktopCollection `presentIn:"body"`
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDesktopsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDesktopsResponse) String() string
ListDesktopsSortByEnum Enum with underlying type: string
type ListDesktopsSortByEnum string
Set of constants representing the allowable values for ListDesktopsSortByEnum
const (
ListDesktopsSortByTimecreated ListDesktopsSortByEnum = "TIMECREATED"
ListDesktopsSortByDisplayname ListDesktopsSortByEnum = "DISPLAYNAME"
)
func GetListDesktopsSortByEnumValues() []ListDesktopsSortByEnum
GetListDesktopsSortByEnumValues Enumerates the set of values for ListDesktopsSortByEnum
func GetMappingListDesktopsSortByEnum(val string) (ListDesktopsSortByEnum, bool)
GetMappingListDesktopsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDesktopsSortOrderEnum Enum with underlying type: string
type ListDesktopsSortOrderEnum string
Set of constants representing the allowable values for ListDesktopsSortOrderEnum
const (
ListDesktopsSortOrderAsc ListDesktopsSortOrderEnum = "ASC"
ListDesktopsSortOrderDesc ListDesktopsSortOrderEnum = "DESC"
)
func GetListDesktopsSortOrderEnumValues() []ListDesktopsSortOrderEnum
GetListDesktopsSortOrderEnumValues Enumerates the set of values for ListDesktopsSortOrderEnum
func GetMappingListDesktopsSortOrderEnum(val string) (ListDesktopsSortOrderEnum, bool)
GetMappingListDesktopsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of results to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A field to indicate the sort order.
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For pagination.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of results to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A field to indicate the sort order.
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For pagination.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID of the compartment of the desktop pool.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The ID of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only resources their lifecycleState matches the given OperationStatus.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The ID of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of results to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A field to indicate the sort order.
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `presentIn:"body"`
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
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"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateDesktopPool OperationTypeEnum = "CREATE_DESKTOP_POOL"
OperationTypeUpdateDesktopPool OperationTypeEnum = "UPDATE_DESKTOP_POOL"
OperationTypeDeleteDesktopPool OperationTypeEnum = "DELETE_DESKTOP_POOL"
OperationTypeMoveDesktopPool OperationTypeEnum = "MOVE_DESKTOP_POOL"
OperationTypeStartDesktopPool OperationTypeEnum = "START_DESKTOP_POOL"
OperationTypeStopDesktopPool OperationTypeEnum = "STOP_DESKTOP_POOL"
OperationTypeDeleteDesktop OperationTypeEnum = "DELETE_DESKTOP"
OperationTypeUpdateDesktop OperationTypeEnum = "UPDATE_DESKTOP"
OperationTypeStartDesktop OperationTypeEnum = "START_DESKTOP"
OperationTypeStopDesktop OperationTypeEnum = "STOP_DESKTOP"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
StartDesktopPoolRequest wrapper for the StartDesktopPool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/StartDesktopPool.go.html to see an example of how to use StartDesktopPoolRequest.
type StartDesktopPoolRequest struct {
// The OCID of the desktop pool.
DesktopPoolId *string `mandatory:"true" contributesTo:"path" name:"desktopPoolId"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StartDesktopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartDesktopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartDesktopPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartDesktopPoolRequest) String() string
func (request StartDesktopPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StartDesktopPoolResponse wrapper for the StartDesktopPool operation
type StartDesktopPoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A unique identifier for an asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response StartDesktopPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartDesktopPoolResponse) String() string
StartDesktopRequest wrapper for the StartDesktop operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/StartDesktop.go.html to see an example of how to use StartDesktopRequest.
type StartDesktopRequest struct {
// The OCID of the desktop.
DesktopId *string `mandatory:"true" contributesTo:"path" name:"desktopId"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StartDesktopRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartDesktopRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartDesktopRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartDesktopRequest) String() string
func (request StartDesktopRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StartDesktopResponse wrapper for the StartDesktop operation
type StartDesktopResponse struct {
// The underlying http response
RawResponse *http.Response
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A unique identifier for an asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response StartDesktopResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartDesktopResponse) String() string
StopDesktopPoolRequest wrapper for the StopDesktopPool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/StopDesktopPool.go.html to see an example of how to use StopDesktopPoolRequest.
type StopDesktopPoolRequest struct {
// The OCID of the desktop pool.
DesktopPoolId *string `mandatory:"true" contributesTo:"path" name:"desktopPoolId"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StopDesktopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopDesktopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopDesktopPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopDesktopPoolRequest) String() string
func (request StopDesktopPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StopDesktopPoolResponse wrapper for the StopDesktopPool operation
type StopDesktopPoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A unique identifier for an asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response StopDesktopPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopDesktopPoolResponse) String() string
StopDesktopRequest wrapper for the StopDesktop operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/StopDesktop.go.html to see an example of how to use StopDesktopRequest.
type StopDesktopRequest struct {
// The OCID of the desktop.
DesktopId *string `mandatory:"true" contributesTo:"path" name:"desktopId"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Force a STOP(power off) of the desktop if set to false
IsSoftStop *bool `mandatory:"false" contributesTo:"query" name:"isSoftStop"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StopDesktopRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopDesktopRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopDesktopRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopDesktopRequest) String() string
func (request StopDesktopRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StopDesktopResponse wrapper for the StopDesktop operation
type StopDesktopResponse struct {
// The underlying http response
RawResponse *http.Response
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A unique identifier for an asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response StopDesktopResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopDesktopResponse) String() string
UpdateDesktopDetails Provides the details of an updated desktop.
type UpdateDesktopDetails struct {
// A user friendly display name. 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDesktopDetails) String() string
func (m UpdateDesktopDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDesktopPoolDesktopSessionLifecycleActions The update details of action to be triggered in case of inactivity or disconnect
type UpdateDesktopPoolDesktopSessionLifecycleActions struct {
Inactivity *InactivityConfig `mandatory:"false" json:"inactivity"`
Disconnect *DisconnectConfig `mandatory:"false" json:"disconnect"`
}
func (m UpdateDesktopPoolDesktopSessionLifecycleActions) String() string
func (m UpdateDesktopPoolDesktopSessionLifecycleActions) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDesktopPoolDetails Provides the details of a request to update the desktop pool.
type UpdateDesktopPoolDetails struct {
// A user friendly display name. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A user friendly description providing additional information about the resource.
// Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// The maximum number of desktops permitted in the desktop pool.
MaximumSize *int `mandatory:"false" json:"maximumSize"`
// The maximum number of standby desktops available in the desktop pool.
StandbySize *int `mandatory:"false" json:"standbySize"`
DevicePolicy *DesktopDevicePolicy `mandatory:"false" json:"devicePolicy"`
AvailabilityPolicy *DesktopAvailabilityPolicy `mandatory:"false" json:"availabilityPolicy"`
// Contact information of the desktop pool administrator.
// Avoid entering confidential information.
ContactDetails *string `mandatory:"false" json:"contactDetails"`
// The start time of the desktop pool.
TimeStartScheduled *common.SDKTime `mandatory:"false" json:"timeStartScheduled"`
// The stop time of the desktop pool.
TimeStopScheduled *common.SDKTime `mandatory:"false" json:"timeStopScheduled"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
SessionLifecycleActions *UpdateDesktopPoolDesktopSessionLifecycleActions `mandatory:"false" json:"sessionLifecycleActions"`
}
func (m UpdateDesktopPoolDetails) String() string
func (m UpdateDesktopPoolDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDesktopPoolRequest wrapper for the UpdateDesktopPool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/UpdateDesktopPool.go.html to see an example of how to use UpdateDesktopPoolRequest.
type UpdateDesktopPoolRequest struct {
// The OCID of the desktop pool.
DesktopPoolId *string `mandatory:"true" contributesTo:"path" name:"desktopPoolId"`
// The details of the update.
UpdateDesktopPoolDetails `contributesTo:"body"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateDesktopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDesktopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDesktopPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDesktopPoolRequest) String() string
func (request UpdateDesktopPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDesktopPoolResponse wrapper for the UpdateDesktopPool operation
type UpdateDesktopPoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A unique identifier for an asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateDesktopPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDesktopPoolResponse) String() string
UpdateDesktopRequest wrapper for the UpdateDesktop operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/UpdateDesktop.go.html to see an example of how to use UpdateDesktopRequest.
type UpdateDesktopRequest struct {
// The OCID of the desktop.
DesktopId *string `mandatory:"true" contributesTo:"path" name:"desktopId"`
// The details of the update.
UpdateDesktopDetails `contributesTo:"body"`
// The unique identifier of the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateDesktopRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDesktopRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDesktopRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDesktopRequest) String() string
func (request UpdateDesktopRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDesktopResponse wrapper for the UpdateDesktop operation
type UpdateDesktopResponse struct {
// The underlying http response
RawResponse *http.Response
// The unique identifier of the request.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A unique identifier for an asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateDesktopResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDesktopResponse) String() string
WorkRequest A description of workrequest status.
type WorkRequest struct {
// Type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed on
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection Results of a workRequestError search.
type WorkRequestErrorCollection struct {
// List of workRequestError objects.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection Results of a workRequestLog search.
type WorkRequestLogEntryCollection struct {
// List of workRequestLogEntries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource A resource created or operated on 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 is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummary A summary of the status of a work request.
type WorkRequestSummary struct {
// Type of the work request
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummaryCollection Results of a workRequest search.
type WorkRequestSummaryCollection struct {
// List of workRequestSummary objects.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly