desktops

package
v65.65.1 Latest Latest
Warning

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

 Go to latest Published: May 7, 2024 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues 

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetDesktopDevicePolicyAudioModeEnumStringValues 

func GetDesktopDevicePolicyAudioModeEnumStringValues() []string

GetDesktopDevicePolicyAudioModeEnumStringValues Enumerates the set of values in String for DesktopDevicePolicyAudioModeEnum

func GetDesktopDevicePolicyCdmModeEnumStringValues 

func GetDesktopDevicePolicyCdmModeEnumStringValues() []string

GetDesktopDevicePolicyCdmModeEnumStringValues Enumerates the set of values in String for DesktopDevicePolicyCdmModeEnum

func GetDesktopDevicePolicyClipboardModeEnumStringValues 

func GetDesktopDevicePolicyClipboardModeEnumStringValues() []string

GetDesktopDevicePolicyClipboardModeEnumStringValues Enumerates the set of values in String for DesktopDevicePolicyClipboardModeEnum

func GetDesktopPoolVolumeSummaryLifecycleStateEnumStringValues 

func GetDesktopPoolVolumeSummaryLifecycleStateEnumStringValues() []string

GetDesktopPoolVolumeSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for DesktopPoolVolumeSummaryLifecycleStateEnum

func GetLifecycleStateEnumStringValues 

func GetLifecycleStateEnumStringValues() []string

GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum

func GetListDesktopPoolDesktopsSortByEnumStringValues 

func GetListDesktopPoolDesktopsSortByEnumStringValues() []string

GetListDesktopPoolDesktopsSortByEnumStringValues Enumerates the set of values in String for ListDesktopPoolDesktopsSortByEnum

func GetListDesktopPoolDesktopsSortOrderEnumStringValues 

func GetListDesktopPoolDesktopsSortOrderEnumStringValues() []string

GetListDesktopPoolDesktopsSortOrderEnumStringValues Enumerates the set of values in String for ListDesktopPoolDesktopsSortOrderEnum

func GetListDesktopPoolVolumesSortByEnumStringValues 

func GetListDesktopPoolVolumesSortByEnumStringValues() []string

GetListDesktopPoolVolumesSortByEnumStringValues Enumerates the set of values in String for ListDesktopPoolVolumesSortByEnum

func GetListDesktopPoolVolumesSortOrderEnumStringValues 

func GetListDesktopPoolVolumesSortOrderEnumStringValues() []string

GetListDesktopPoolVolumesSortOrderEnumStringValues Enumerates the set of values in String for ListDesktopPoolVolumesSortOrderEnum

func GetListDesktopPoolsSortByEnumStringValues 

func GetListDesktopPoolsSortByEnumStringValues() []string

GetListDesktopPoolsSortByEnumStringValues Enumerates the set of values in String for ListDesktopPoolsSortByEnum

func GetListDesktopPoolsSortOrderEnumStringValues 

func GetListDesktopPoolsSortOrderEnumStringValues() []string

GetListDesktopPoolsSortOrderEnumStringValues Enumerates the set of values in String for ListDesktopPoolsSortOrderEnum

func GetListDesktopsSortByEnumStringValues 

func GetListDesktopsSortByEnumStringValues() []string

GetListDesktopsSortByEnumStringValues Enumerates the set of values in String for ListDesktopsSortByEnum

func GetListDesktopsSortOrderEnumStringValues 

func GetListDesktopsSortOrderEnumStringValues() []string

GetListDesktopsSortOrderEnumStringValues Enumerates the set of values in String for ListDesktopsSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues 

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues 

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues 

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues 

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues 

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues 

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues 

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetOperationStatusEnumStringValues 

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues 

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

Types

type ActionTypeEnum 

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string 

const (
	ActionTypeCreated    ActionTypeEnum = "CREATED"
	ActionTypeUpdated    ActionTypeEnum = "UPDATED"
	ActionTypeDeleted    ActionTypeEnum = "DELETED"
	ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
	ActionTypeRelated    ActionTypeEnum = "RELATED"
	ActionTypeFailed     ActionTypeEnum = "FAILED"
)

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues 

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum 

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

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

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.

func (CancelWorkRequestRequest) BinaryRequestBody 

func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CancelWorkRequestRequest) HTTPRequest 

func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy 

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

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

func (CancelWorkRequestRequest) String 

func (request CancelWorkRequestRequest) String() string

func (CancelWorkRequestRequest) ValidateEnumValue 

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

type CancelWorkRequestResponse 

type CancelWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The unique identifier of the request.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

func (CancelWorkRequestResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String 

func (response CancelWorkRequestResponse) String() string

type ChangeDesktopPoolCompartmentDetails 

type ChangeDesktopPoolCompartmentDetails struct {

	// The OCID of the compartment which will contain the desktop pool.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeDesktopPoolCompartmentDetails Provides the OCID of the new compartment that will contain the desktop pool.

func (ChangeDesktopPoolCompartmentDetails) String 

func (m ChangeDesktopPoolCompartmentDetails) String() string

func (ChangeDesktopPoolCompartmentDetails) ValidateEnumValue 

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

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

ChangeDesktopPoolCompartmentRequest wrapper for the ChangeDesktopPoolCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ChangeDesktopPoolCompartment.go.html to see an example of how to use ChangeDesktopPoolCompartmentRequest.

func (ChangeDesktopPoolCompartmentRequest) BinaryRequestBody 

func (request ChangeDesktopPoolCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeDesktopPoolCompartmentRequest) HTTPRequest 

func (request ChangeDesktopPoolCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeDesktopPoolCompartmentRequest) RetryPolicy 

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

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

func (ChangeDesktopPoolCompartmentRequest) String 

func (request ChangeDesktopPoolCompartmentRequest) String() string

func (ChangeDesktopPoolCompartmentRequest) ValidateEnumValue 

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

type ChangeDesktopPoolCompartmentResponse 

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

ChangeDesktopPoolCompartmentResponse wrapper for the ChangeDesktopPoolCompartment operation

func (ChangeDesktopPoolCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ChangeDesktopPoolCompartmentResponse) String 

func (response ChangeDesktopPoolCompartmentResponse) String() string

type CreateDesktopPoolDetails 

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

	// 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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A list of network security groups for the desktop pool.
	NsgIds []string `mandatory:"false" json:"nsgIds"`
}

CreateDesktopPoolDetails Provides the configuration information used to create the desktop pool.

func (CreateDesktopPoolDetails) String 

func (m CreateDesktopPoolDetails) String() string

func (CreateDesktopPoolDetails) ValidateEnumValue 

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

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

CreateDesktopPoolRequest wrapper for the CreateDesktopPool operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/CreateDesktopPool.go.html to see an example of how to use CreateDesktopPoolRequest.

func (CreateDesktopPoolRequest) BinaryRequestBody 

func (request CreateDesktopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDesktopPoolRequest) HTTPRequest 

func (request CreateDesktopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDesktopPoolRequest) RetryPolicy 

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

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

func (CreateDesktopPoolRequest) String 

func (request CreateDesktopPoolRequest) String() string

func (CreateDesktopPoolRequest) ValidateEnumValue 

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

type CreateDesktopPoolResponse 

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

CreateDesktopPoolResponse wrapper for the CreateDesktopPool operation

func (CreateDesktopPoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateDesktopPoolResponse) String 

func (response CreateDesktopPoolResponse) String() string

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

DeleteDesktopPoolRequest wrapper for the DeleteDesktopPool operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/DeleteDesktopPool.go.html to see an example of how to use DeleteDesktopPoolRequest.

func (DeleteDesktopPoolRequest) BinaryRequestBody 

func (request DeleteDesktopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDesktopPoolRequest) HTTPRequest 

func (request DeleteDesktopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDesktopPoolRequest) RetryPolicy 

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

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

func (DeleteDesktopPoolRequest) String 

func (request DeleteDesktopPoolRequest) String() string

func (DeleteDesktopPoolRequest) ValidateEnumValue 

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

type DeleteDesktopPoolResponse 

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

DeleteDesktopPoolResponse wrapper for the DeleteDesktopPool operation

func (DeleteDesktopPoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteDesktopPoolResponse) String 

func (response DeleteDesktopPoolResponse) String() string

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

DeleteDesktopRequest wrapper for the DeleteDesktop operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/DeleteDesktop.go.html to see an example of how to use DeleteDesktopRequest.

func (DeleteDesktopRequest) BinaryRequestBody 

func (request DeleteDesktopRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDesktopRequest) HTTPRequest 

func (request DeleteDesktopRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDesktopRequest) RetryPolicy 

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

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

func (DeleteDesktopRequest) String 

func (request DeleteDesktopRequest) String() string

func (DeleteDesktopRequest) ValidateEnumValue 

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

type DeleteDesktopResponse 

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

DeleteDesktopResponse wrapper for the DeleteDesktop operation

func (DeleteDesktopResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteDesktopResponse) String 

func (response DeleteDesktopResponse) String() string

type Desktop 

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Desktop Provides information about a desktop including name, state, id, configuration, owner, and time created.

func (Desktop) String 

func (m Desktop) String() string

func (Desktop) ValidateEnumValue 

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

type DesktopAvailabilityPolicy 

type DesktopAvailabilityPolicy struct {
	StartSchedule *DesktopSchedule `mandatory:"true" json:"startSchedule"`

	StopSchedule *DesktopSchedule `mandatory:"true" json:"stopSchedule"`
}

DesktopAvailabilityPolicy Provides the start and stop schedule information for desktop availability of the desktop pool.

func (DesktopAvailabilityPolicy) String 

func (m DesktopAvailabilityPolicy) String() string

func (DesktopAvailabilityPolicy) ValidateEnumValue 

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

type DesktopCollection 

type DesktopCollection struct {

	// A list of desktop summaries.
	Items []DesktopSummary `mandatory:"true" json:"items"`
}

DesktopCollection A list of desktops.

func (DesktopCollection) String 

func (m DesktopCollection) String() string

func (DesktopCollection) ValidateEnumValue 

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

type DesktopDevicePolicy 

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

DesktopDevicePolicy Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.

func (DesktopDevicePolicy) String 

func (m DesktopDevicePolicy) String() string

func (DesktopDevicePolicy) ValidateEnumValue 

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

type DesktopDevicePolicyAudioModeEnum 

type DesktopDevicePolicyAudioModeEnum string

DesktopDevicePolicyAudioModeEnum Enum with underlying type: string 

const (
	DesktopDevicePolicyAudioModeNone        DesktopDevicePolicyAudioModeEnum = "NONE"
	DesktopDevicePolicyAudioModeTodesktop   DesktopDevicePolicyAudioModeEnum = "TODESKTOP"
	DesktopDevicePolicyAudioModeFromdesktop DesktopDevicePolicyAudioModeEnum = "FROMDESKTOP"
	DesktopDevicePolicyAudioModeFull        DesktopDevicePolicyAudioModeEnum = "FULL"
)

Set of constants representing the allowable values for DesktopDevicePolicyAudioModeEnum

func GetDesktopDevicePolicyAudioModeEnumValues 

func GetDesktopDevicePolicyAudioModeEnumValues() []DesktopDevicePolicyAudioModeEnum

GetDesktopDevicePolicyAudioModeEnumValues Enumerates the set of values for DesktopDevicePolicyAudioModeEnum

func GetMappingDesktopDevicePolicyAudioModeEnum 

func GetMappingDesktopDevicePolicyAudioModeEnum(val string) (DesktopDevicePolicyAudioModeEnum, bool)

GetMappingDesktopDevicePolicyAudioModeEnum performs case Insensitive comparison on enum value and return the desired enum

type DesktopDevicePolicyCdmModeEnum 

type DesktopDevicePolicyCdmModeEnum string

DesktopDevicePolicyCdmModeEnum Enum with underlying type: string 

const (
	DesktopDevicePolicyCdmModeNone     DesktopDevicePolicyCdmModeEnum = "NONE"
	DesktopDevicePolicyCdmModeReadonly DesktopDevicePolicyCdmModeEnum = "READONLY"
	DesktopDevicePolicyCdmModeFull     DesktopDevicePolicyCdmModeEnum = "FULL"
)

Set of constants representing the allowable values for DesktopDevicePolicyCdmModeEnum

func GetDesktopDevicePolicyCdmModeEnumValues 

func GetDesktopDevicePolicyCdmModeEnumValues() []DesktopDevicePolicyCdmModeEnum

GetDesktopDevicePolicyCdmModeEnumValues Enumerates the set of values for DesktopDevicePolicyCdmModeEnum

func GetMappingDesktopDevicePolicyCdmModeEnum 

func GetMappingDesktopDevicePolicyCdmModeEnum(val string) (DesktopDevicePolicyCdmModeEnum, bool)

GetMappingDesktopDevicePolicyCdmModeEnum performs case Insensitive comparison on enum value and return the desired enum

type DesktopDevicePolicyClipboardModeEnum 

type DesktopDevicePolicyClipboardModeEnum string

DesktopDevicePolicyClipboardModeEnum Enum with underlying type: string 

const (
	DesktopDevicePolicyClipboardModeNone        DesktopDevicePolicyClipboardModeEnum = "NONE"
	DesktopDevicePolicyClipboardModeTodesktop   DesktopDevicePolicyClipboardModeEnum = "TODESKTOP"
	DesktopDevicePolicyClipboardModeFromdesktop DesktopDevicePolicyClipboardModeEnum = "FROMDESKTOP"
	DesktopDevicePolicyClipboardModeFull        DesktopDevicePolicyClipboardModeEnum = "FULL"
)

Set of constants representing the allowable values for DesktopDevicePolicyClipboardModeEnum

func GetDesktopDevicePolicyClipboardModeEnumValues 

func GetDesktopDevicePolicyClipboardModeEnumValues() []DesktopDevicePolicyClipboardModeEnum

GetDesktopDevicePolicyClipboardModeEnumValues Enumerates the set of values for DesktopDevicePolicyClipboardModeEnum

func GetMappingDesktopDevicePolicyClipboardModeEnum 

func GetMappingDesktopDevicePolicyClipboardModeEnum(val string) (DesktopDevicePolicyClipboardModeEnum, bool)

GetMappingDesktopDevicePolicyClipboardModeEnum performs case Insensitive comparison on enum value and return the desired enum

type DesktopImage 

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

DesktopImage Provides information about the desktop image.

func (DesktopImage) String 

func (m DesktopImage) String() string

func (DesktopImage) ValidateEnumValue 

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

type DesktopNetworkConfiguration 

type DesktopNetworkConfiguration struct {

	// The OCID of the VCN used by the desktop pool.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// The OCID of the subnet to use for the desktop pool.
	SubnetId *string `mandatory:"true" json:"subnetId"`
}

DesktopNetworkConfiguration Provides information about the network configuration of the desktop pool.

func (DesktopNetworkConfiguration) String 

func (m DesktopNetworkConfiguration) String() string

func (DesktopNetworkConfiguration) ValidateEnumValue 

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

type DesktopPool 

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

	// 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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A list of network security groups for the desktop pool.
	NsgIds []string `mandatory:"false" json:"nsgIds"`
}

DesktopPool Provides information about a desktop pool including all configuration parameters.

func (DesktopPool) String 

func (m DesktopPool) String() string

func (DesktopPool) ValidateEnumValue 

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

type DesktopPoolCollection 

type DesktopPoolCollection struct {

	// A list of desktop pool summaries.
	Items []DesktopPoolSummary `mandatory:"true" json:"items"`
}

DesktopPoolCollection A list of desktop pools.

func (DesktopPoolCollection) String 

func (m DesktopPoolCollection) String() string

func (DesktopPoolCollection) ValidateEnumValue 

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

type DesktopPoolDesktopCollection 

type DesktopPoolDesktopCollection struct {

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

DesktopPoolDesktopCollection A list of desktops within a desktop pool.

func (DesktopPoolDesktopCollection) String 

func (m DesktopPoolDesktopCollection) String() string

func (DesktopPoolDesktopCollection) ValidateEnumValue 

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

type DesktopPoolDesktopSummary 

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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.

func (DesktopPoolDesktopSummary) String 

func (m DesktopPoolDesktopSummary) String() string

func (DesktopPoolDesktopSummary) ValidateEnumValue 

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

type DesktopPoolSummary 

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

DesktopPoolSummary Provides information about the desktop pool such as number of active desktops, name, OCID, state, and maximum size.

func (DesktopPoolSummary) String 

func (m DesktopPoolSummary) String() string

func (DesktopPoolSummary) ValidateEnumValue 

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

type DesktopPoolVolumeCollection 

type DesktopPoolVolumeCollection struct {

	// A list of desktop pool volumes.
	Items []DesktopPoolVolumeSummary `mandatory:"true" json:"items"`
}

DesktopPoolVolumeCollection A list of volumes within a desktop pool.

func (DesktopPoolVolumeCollection) String 

func (m DesktopPoolVolumeCollection) String() string

func (DesktopPoolVolumeCollection) ValidateEnumValue 

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

type DesktopPoolVolumeSummary 

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

DesktopPoolVolumeSummary Provides information about a volume within the desktop pool.

func (DesktopPoolVolumeSummary) String 

func (m DesktopPoolVolumeSummary) String() string

func (DesktopPoolVolumeSummary) ValidateEnumValue 

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

type DesktopPoolVolumeSummaryLifecycleStateEnum 

type DesktopPoolVolumeSummaryLifecycleStateEnum string

DesktopPoolVolumeSummaryLifecycleStateEnum Enum with underlying type: string 

const (
	DesktopPoolVolumeSummaryLifecycleStateActive   DesktopPoolVolumeSummaryLifecycleStateEnum = "ACTIVE"
	DesktopPoolVolumeSummaryLifecycleStateInactive DesktopPoolVolumeSummaryLifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for DesktopPoolVolumeSummaryLifecycleStateEnum

func GetDesktopPoolVolumeSummaryLifecycleStateEnumValues 

func GetDesktopPoolVolumeSummaryLifecycleStateEnumValues() []DesktopPoolVolumeSummaryLifecycleStateEnum

GetDesktopPoolVolumeSummaryLifecycleStateEnumValues Enumerates the set of values for DesktopPoolVolumeSummaryLifecycleStateEnum

func GetMappingDesktopPoolVolumeSummaryLifecycleStateEnum 

func GetMappingDesktopPoolVolumeSummaryLifecycleStateEnum(val string) (DesktopPoolVolumeSummaryLifecycleStateEnum, bool)

GetMappingDesktopPoolVolumeSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DesktopSchedule 

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

DesktopSchedule Provides the schedule information for a desktop.

func (DesktopSchedule) String 

func (m DesktopSchedule) String() string

func (DesktopSchedule) ValidateEnumValue 

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

type DesktopServiceClient 

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

DesktopServiceClient a client for DesktopService

func NewDesktopServiceClientWithConfigurationProvider 

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 

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 (DesktopServiceClient) CancelWorkRequest 

func (client DesktopServiceClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)

CancelWorkRequest Cancel work request with the given ID.

See also

Click https://docs.cloud.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 (DesktopServiceClient) ChangeDesktopPoolCompartment 

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.

See also

Click https://docs.cloud.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 (*DesktopServiceClient) ConfigurationProvider 

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

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

func (DesktopServiceClient) CreateDesktopPool 

func (client DesktopServiceClient) CreateDesktopPool(ctx context.Context, request CreateDesktopPoolRequest) (response CreateDesktopPoolResponse, err error)

CreateDesktopPool Creates a desktop pool with the given configuration parameters.

See also

Click https://docs.cloud.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 (DesktopServiceClient) DeleteDesktop 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) DeleteDesktopPool 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) GetDesktop 

func (client DesktopServiceClient) GetDesktop(ctx context.Context, request GetDesktopRequest) (response GetDesktopResponse, err error)

GetDesktop Provides information about the desktop with the specified OCID.

See also

Click https://docs.cloud.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 (DesktopServiceClient) GetDesktopPool 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) GetWorkRequest 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) ListDesktopPoolDesktops 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) ListDesktopPoolVolumes 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) ListDesktopPools 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) ListDesktops 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) ListWorkRequestErrors 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) ListWorkRequestLogs 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) ListWorkRequests 

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

ListWorkRequests Lists the work requests in a compartment.

See also

Click https://docs.cloud.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 (*DesktopServiceClient) SetRegion 

func (client *DesktopServiceClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (DesktopServiceClient) StartDesktop 

func (client DesktopServiceClient) StartDesktop(ctx context.Context, request StartDesktopRequest) (response StartDesktopResponse, err error)

StartDesktop Starts the desktop with the specified OCID.

See also

Click https://docs.cloud.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 (DesktopServiceClient) StartDesktopPool 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) StopDesktop 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) StopDesktopPool 

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.

See also

Click https://docs.cloud.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 (DesktopServiceClient) UpdateDesktop 

func (client DesktopServiceClient) UpdateDesktop(ctx context.Context, request UpdateDesktopRequest) (response UpdateDesktopResponse, err error)

UpdateDesktop Modifies information about the desktop such as the name.

See also

Click https://docs.cloud.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 (DesktopServiceClient) UpdateDesktopPool 

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.

See also

Click https://docs.cloud.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()

type DesktopSummary 

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

DesktopSummary Provides information about a desktop.

func (DesktopSummary) String 

func (m DesktopSummary) String() string

func (DesktopSummary) ValidateEnumValue 

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

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

GetDesktopPoolRequest wrapper for the GetDesktopPool operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/GetDesktopPool.go.html to see an example of how to use GetDesktopPoolRequest.

func (GetDesktopPoolRequest) BinaryRequestBody 

func (request GetDesktopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDesktopPoolRequest) HTTPRequest 

func (request GetDesktopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDesktopPoolRequest) RetryPolicy 

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

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

func (GetDesktopPoolRequest) String 

func (request GetDesktopPoolRequest) String() string

func (GetDesktopPoolRequest) ValidateEnumValue 

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

type GetDesktopPoolResponse 

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

GetDesktopPoolResponse wrapper for the GetDesktopPool operation

func (GetDesktopPoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetDesktopPoolResponse) String 

func (response GetDesktopPoolResponse) String() string

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

GetDesktopRequest wrapper for the GetDesktop operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/GetDesktop.go.html to see an example of how to use GetDesktopRequest.

func (GetDesktopRequest) BinaryRequestBody 

func (request GetDesktopRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDesktopRequest) HTTPRequest 

func (request GetDesktopRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDesktopRequest) RetryPolicy 

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

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

func (GetDesktopRequest) String 

func (request GetDesktopRequest) String() string

func (GetDesktopRequest) ValidateEnumValue 

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

type GetDesktopResponse 

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

GetDesktopResponse wrapper for the GetDesktop operation

func (GetDesktopResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetDesktopResponse) String 

func (response GetDesktopResponse) String() string

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

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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

func (GetWorkRequestRequest) BinaryRequestBody 

func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest 

func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy 

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

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

func (GetWorkRequestRequest) String 

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue 

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

type GetWorkRequestResponse 

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String 

func (response GetWorkRequestResponse) String() string

type HostingOptions 

type HostingOptions struct {
	Image *DesktopImage `mandatory:"true" json:"image"`

	// The connection address of the desktop.
	ConnectAddress *string `mandatory:"true" json:"connectAddress"`
}

HostingOptions Provides information about where a desktop is hosted.

func (HostingOptions) String 

func (m HostingOptions) String() string

func (HostingOptions) ValidateEnumValue 

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

type LifecycleStateEnum 

type LifecycleStateEnum string

LifecycleStateEnum Enum with underlying type: string 

const (
	LifecycleStateCreating LifecycleStateEnum = "CREATING"
	LifecycleStateActive   LifecycleStateEnum = "ACTIVE"
	LifecycleStateInactive LifecycleStateEnum = "INACTIVE"
	LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
	LifecycleStateDeleting LifecycleStateEnum = "DELETING"
	LifecycleStateDeleted  LifecycleStateEnum = "DELETED"
	LifecycleStateFailed   LifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for LifecycleStateEnum

func GetLifecycleStateEnumValues 

func GetLifecycleStateEnumValues() []LifecycleStateEnum

GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum

func GetMappingLifecycleStateEnum 

func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)

GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListDesktopPoolDesktopsRequest wrapper for the ListDesktopPoolDesktops operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListDesktopPoolDesktops.go.html to see an example of how to use ListDesktopPoolDesktopsRequest.

func (ListDesktopPoolDesktopsRequest) BinaryRequestBody 

func (request ListDesktopPoolDesktopsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDesktopPoolDesktopsRequest) HTTPRequest 

func (request ListDesktopPoolDesktopsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDesktopPoolDesktopsRequest) RetryPolicy 

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

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

func (ListDesktopPoolDesktopsRequest) String 

func (request ListDesktopPoolDesktopsRequest) String() string

func (ListDesktopPoolDesktopsRequest) ValidateEnumValue 

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

type ListDesktopPoolDesktopsResponse 

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

ListDesktopPoolDesktopsResponse wrapper for the ListDesktopPoolDesktops operation

func (ListDesktopPoolDesktopsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListDesktopPoolDesktopsResponse) String 

func (response ListDesktopPoolDesktopsResponse) String() string

type ListDesktopPoolDesktopsSortByEnum 

type ListDesktopPoolDesktopsSortByEnum string

ListDesktopPoolDesktopsSortByEnum Enum with underlying type: string 

const (
	ListDesktopPoolDesktopsSortByTimecreated ListDesktopPoolDesktopsSortByEnum = "TIMECREATED"
	ListDesktopPoolDesktopsSortByDisplayname ListDesktopPoolDesktopsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListDesktopPoolDesktopsSortByEnum

func GetListDesktopPoolDesktopsSortByEnumValues 

func GetListDesktopPoolDesktopsSortByEnumValues() []ListDesktopPoolDesktopsSortByEnum

GetListDesktopPoolDesktopsSortByEnumValues Enumerates the set of values for ListDesktopPoolDesktopsSortByEnum

func GetMappingListDesktopPoolDesktopsSortByEnum 

func GetMappingListDesktopPoolDesktopsSortByEnum(val string) (ListDesktopPoolDesktopsSortByEnum, bool)

GetMappingListDesktopPoolDesktopsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDesktopPoolDesktopsSortOrderEnum 

type ListDesktopPoolDesktopsSortOrderEnum string

ListDesktopPoolDesktopsSortOrderEnum Enum with underlying type: string 

const (
	ListDesktopPoolDesktopsSortOrderAsc  ListDesktopPoolDesktopsSortOrderEnum = "ASC"
	ListDesktopPoolDesktopsSortOrderDesc ListDesktopPoolDesktopsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDesktopPoolDesktopsSortOrderEnum

func GetListDesktopPoolDesktopsSortOrderEnumValues 

func GetListDesktopPoolDesktopsSortOrderEnumValues() []ListDesktopPoolDesktopsSortOrderEnum

GetListDesktopPoolDesktopsSortOrderEnumValues Enumerates the set of values for ListDesktopPoolDesktopsSortOrderEnum

func GetMappingListDesktopPoolDesktopsSortOrderEnum 

func GetMappingListDesktopPoolDesktopsSortOrderEnum(val string) (ListDesktopPoolDesktopsSortOrderEnum, bool)

GetMappingListDesktopPoolDesktopsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListDesktopPoolVolumesRequest wrapper for the ListDesktopPoolVolumes operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListDesktopPoolVolumes.go.html to see an example of how to use ListDesktopPoolVolumesRequest.

func (ListDesktopPoolVolumesRequest) BinaryRequestBody 

func (request ListDesktopPoolVolumesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDesktopPoolVolumesRequest) HTTPRequest 

func (request ListDesktopPoolVolumesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDesktopPoolVolumesRequest) RetryPolicy 

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

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

func (ListDesktopPoolVolumesRequest) String 

func (request ListDesktopPoolVolumesRequest) String() string

func (ListDesktopPoolVolumesRequest) ValidateEnumValue 

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

type ListDesktopPoolVolumesResponse 

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

ListDesktopPoolVolumesResponse wrapper for the ListDesktopPoolVolumes operation

func (ListDesktopPoolVolumesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListDesktopPoolVolumesResponse) String 

func (response ListDesktopPoolVolumesResponse) String() string

type ListDesktopPoolVolumesSortByEnum 

type ListDesktopPoolVolumesSortByEnum string

ListDesktopPoolVolumesSortByEnum Enum with underlying type: string 

const (
	ListDesktopPoolVolumesSortByTimecreated ListDesktopPoolVolumesSortByEnum = "TIMECREATED"
	ListDesktopPoolVolumesSortByDisplayname ListDesktopPoolVolumesSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListDesktopPoolVolumesSortByEnum

func GetListDesktopPoolVolumesSortByEnumValues 

func GetListDesktopPoolVolumesSortByEnumValues() []ListDesktopPoolVolumesSortByEnum

GetListDesktopPoolVolumesSortByEnumValues Enumerates the set of values for ListDesktopPoolVolumesSortByEnum

func GetMappingListDesktopPoolVolumesSortByEnum 

func GetMappingListDesktopPoolVolumesSortByEnum(val string) (ListDesktopPoolVolumesSortByEnum, bool)

GetMappingListDesktopPoolVolumesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDesktopPoolVolumesSortOrderEnum 

type ListDesktopPoolVolumesSortOrderEnum string

ListDesktopPoolVolumesSortOrderEnum Enum with underlying type: string 

const (
	ListDesktopPoolVolumesSortOrderAsc  ListDesktopPoolVolumesSortOrderEnum = "ASC"
	ListDesktopPoolVolumesSortOrderDesc ListDesktopPoolVolumesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDesktopPoolVolumesSortOrderEnum

func GetListDesktopPoolVolumesSortOrderEnumValues 

func GetListDesktopPoolVolumesSortOrderEnumValues() []ListDesktopPoolVolumesSortOrderEnum

GetListDesktopPoolVolumesSortOrderEnumValues Enumerates the set of values for ListDesktopPoolVolumesSortOrderEnum

func GetMappingListDesktopPoolVolumesSortOrderEnum 

func GetMappingListDesktopPoolVolumesSortOrderEnum(val string) (ListDesktopPoolVolumesSortOrderEnum, bool)

GetMappingListDesktopPoolVolumesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListDesktopPoolsRequest wrapper for the ListDesktopPools operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListDesktopPools.go.html to see an example of how to use ListDesktopPoolsRequest.

func (ListDesktopPoolsRequest) BinaryRequestBody 

func (request ListDesktopPoolsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDesktopPoolsRequest) HTTPRequest 

func (request ListDesktopPoolsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDesktopPoolsRequest) RetryPolicy 

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

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

func (ListDesktopPoolsRequest) String 

func (request ListDesktopPoolsRequest) String() string

func (ListDesktopPoolsRequest) ValidateEnumValue 

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

type ListDesktopPoolsResponse 

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

ListDesktopPoolsResponse wrapper for the ListDesktopPools operation

func (ListDesktopPoolsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListDesktopPoolsResponse) String 

func (response ListDesktopPoolsResponse) String() string

type ListDesktopPoolsSortByEnum 

type ListDesktopPoolsSortByEnum string

ListDesktopPoolsSortByEnum Enum with underlying type: string 

const (
	ListDesktopPoolsSortByTimecreated ListDesktopPoolsSortByEnum = "TIMECREATED"
	ListDesktopPoolsSortByDisplayname ListDesktopPoolsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListDesktopPoolsSortByEnum

func GetListDesktopPoolsSortByEnumValues 

func GetListDesktopPoolsSortByEnumValues() []ListDesktopPoolsSortByEnum

GetListDesktopPoolsSortByEnumValues Enumerates the set of values for ListDesktopPoolsSortByEnum

func GetMappingListDesktopPoolsSortByEnum 

func GetMappingListDesktopPoolsSortByEnum(val string) (ListDesktopPoolsSortByEnum, bool)

GetMappingListDesktopPoolsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDesktopPoolsSortOrderEnum 

type ListDesktopPoolsSortOrderEnum string

ListDesktopPoolsSortOrderEnum Enum with underlying type: string 

const (
	ListDesktopPoolsSortOrderAsc  ListDesktopPoolsSortOrderEnum = "ASC"
	ListDesktopPoolsSortOrderDesc ListDesktopPoolsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDesktopPoolsSortOrderEnum

func GetListDesktopPoolsSortOrderEnumValues 

func GetListDesktopPoolsSortOrderEnumValues() []ListDesktopPoolsSortOrderEnum

GetListDesktopPoolsSortOrderEnumValues Enumerates the set of values for ListDesktopPoolsSortOrderEnum

func GetMappingListDesktopPoolsSortOrderEnum 

func GetMappingListDesktopPoolsSortOrderEnum(val string) (ListDesktopPoolsSortOrderEnum, bool)

GetMappingListDesktopPoolsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListDesktopsRequest wrapper for the ListDesktops operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/ListDesktops.go.html to see an example of how to use ListDesktopsRequest.

func (ListDesktopsRequest) BinaryRequestBody 

func (request ListDesktopsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDesktopsRequest) HTTPRequest 

func (request ListDesktopsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDesktopsRequest) RetryPolicy 

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

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

func (ListDesktopsRequest) String 

func (request ListDesktopsRequest) String() string

func (ListDesktopsRequest) ValidateEnumValue 

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

type ListDesktopsResponse 

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

ListDesktopsResponse wrapper for the ListDesktops operation

func (ListDesktopsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListDesktopsResponse) String 

func (response ListDesktopsResponse) String() string

type ListDesktopsSortByEnum 

type ListDesktopsSortByEnum string

ListDesktopsSortByEnum Enum with underlying type: string 

const (
	ListDesktopsSortByTimecreated ListDesktopsSortByEnum = "TIMECREATED"
	ListDesktopsSortByDisplayname ListDesktopsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListDesktopsSortByEnum

func GetListDesktopsSortByEnumValues 

func GetListDesktopsSortByEnumValues() []ListDesktopsSortByEnum

GetListDesktopsSortByEnumValues Enumerates the set of values for ListDesktopsSortByEnum

func GetMappingListDesktopsSortByEnum 

func GetMappingListDesktopsSortByEnum(val string) (ListDesktopsSortByEnum, bool)

GetMappingListDesktopsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDesktopsSortOrderEnum 

type ListDesktopsSortOrderEnum string

ListDesktopsSortOrderEnum Enum with underlying type: string 

const (
	ListDesktopsSortOrderAsc  ListDesktopsSortOrderEnum = "ASC"
	ListDesktopsSortOrderDesc ListDesktopsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDesktopsSortOrderEnum

func GetListDesktopsSortOrderEnumValues 

func GetListDesktopsSortOrderEnumValues() []ListDesktopsSortOrderEnum

GetListDesktopsSortOrderEnumValues Enumerates the set of values for ListDesktopsSortOrderEnum

func GetMappingListDesktopsSortOrderEnum 

func GetMappingListDesktopsSortOrderEnum(val string) (ListDesktopsSortOrderEnum, bool)

GetMappingListDesktopsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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

func (ListWorkRequestErrorsRequest) BinaryRequestBody 

func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest 

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy 

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

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

func (ListWorkRequestErrorsRequest) String 

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue 

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

type ListWorkRequestErrorsResponse 

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String 

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum 

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues 

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum 

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestErrorsSortOrderEnum 

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
	ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues 

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum 

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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

func (ListWorkRequestLogsRequest) BinaryRequestBody 

func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest 

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy 

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

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

func (ListWorkRequestLogsRequest) String 

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue 

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

type ListWorkRequestLogsResponse 

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String 

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum 

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues 

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum 

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestLogsSortOrderEnum 

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
	ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues 

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum 

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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

func (ListWorkRequestsRequest) BinaryRequestBody 

func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest 

func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy 

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

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

func (ListWorkRequestsRequest) String 

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue 

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

type ListWorkRequestsResponse 

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String 

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum 

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues 

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum 

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsSortOrderEnum 

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues 

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum 

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsStatusEnum 

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues 

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum 

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type OperationStatusEnum 

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string 

const (
	OperationStatusAccepted   OperationStatusEnum = "ACCEPTED"
	OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
	OperationStatusWaiting    OperationStatusEnum = "WAITING"
	OperationStatusFailed     OperationStatusEnum = "FAILED"
	OperationStatusSucceeded  OperationStatusEnum = "SUCCEEDED"
	OperationStatusCanceling  OperationStatusEnum = "CANCELING"
	OperationStatusCanceled   OperationStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum 

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationStatusEnumValues 

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum 

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum 

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationTypeEnumValues 

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

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

StartDesktopPoolRequest wrapper for the StartDesktopPool operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/StartDesktopPool.go.html to see an example of how to use StartDesktopPoolRequest.

func (StartDesktopPoolRequest) BinaryRequestBody 

func (request StartDesktopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StartDesktopPoolRequest) HTTPRequest 

func (request StartDesktopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StartDesktopPoolRequest) RetryPolicy 

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

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

func (StartDesktopPoolRequest) String 

func (request StartDesktopPoolRequest) String() string

func (StartDesktopPoolRequest) ValidateEnumValue 

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

type StartDesktopPoolResponse 

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

StartDesktopPoolResponse wrapper for the StartDesktopPool operation

func (StartDesktopPoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (StartDesktopPoolResponse) String 

func (response StartDesktopPoolResponse) String() string

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

StartDesktopRequest wrapper for the StartDesktop operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/StartDesktop.go.html to see an example of how to use StartDesktopRequest.

func (StartDesktopRequest) BinaryRequestBody 

func (request StartDesktopRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StartDesktopRequest) HTTPRequest 

func (request StartDesktopRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StartDesktopRequest) RetryPolicy 

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

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

func (StartDesktopRequest) String 

func (request StartDesktopRequest) String() string

func (StartDesktopRequest) ValidateEnumValue 

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

type StartDesktopResponse 

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

StartDesktopResponse wrapper for the StartDesktop operation

func (StartDesktopResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (StartDesktopResponse) String 

func (response StartDesktopResponse) String() string

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

StopDesktopPoolRequest wrapper for the StopDesktopPool operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/StopDesktopPool.go.html to see an example of how to use StopDesktopPoolRequest.

func (StopDesktopPoolRequest) BinaryRequestBody 

func (request StopDesktopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StopDesktopPoolRequest) HTTPRequest 

func (request StopDesktopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StopDesktopPoolRequest) RetryPolicy 

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

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

func (StopDesktopPoolRequest) String 

func (request StopDesktopPoolRequest) String() string

func (StopDesktopPoolRequest) ValidateEnumValue 

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

type StopDesktopPoolResponse 

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

StopDesktopPoolResponse wrapper for the StopDesktopPool operation

func (StopDesktopPoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (StopDesktopPoolResponse) String 

func (response StopDesktopPoolResponse) String() string

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

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

StopDesktopRequest wrapper for the StopDesktop operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/StopDesktop.go.html to see an example of how to use StopDesktopRequest.

func (StopDesktopRequest) BinaryRequestBody 

func (request StopDesktopRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StopDesktopRequest) HTTPRequest 

func (request StopDesktopRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StopDesktopRequest) RetryPolicy 

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

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

func (StopDesktopRequest) String 

func (request StopDesktopRequest) String() string

func (StopDesktopRequest) ValidateEnumValue 

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

type StopDesktopResponse 

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

StopDesktopResponse wrapper for the StopDesktop operation

func (StopDesktopResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (StopDesktopResponse) String 

func (response StopDesktopResponse) String() string

type UpdateDesktopDetails 

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateDesktopDetails Provides the details of an updated desktop.

func (UpdateDesktopDetails) String 

func (m UpdateDesktopDetails) String() string

func (UpdateDesktopDetails) ValidateEnumValue 

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

type UpdateDesktopPoolDetails 

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateDesktopPoolDetails Provides the details of a request to update the desktop pool.

func (UpdateDesktopPoolDetails) String 

func (m UpdateDesktopPoolDetails) String() string

func (UpdateDesktopPoolDetails) ValidateEnumValue 

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

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

UpdateDesktopPoolRequest wrapper for the UpdateDesktopPool operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/UpdateDesktopPool.go.html to see an example of how to use UpdateDesktopPoolRequest.

func (UpdateDesktopPoolRequest) BinaryRequestBody 

func (request UpdateDesktopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDesktopPoolRequest) HTTPRequest 

func (request UpdateDesktopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDesktopPoolRequest) RetryPolicy 

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

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

func (UpdateDesktopPoolRequest) String 

func (request UpdateDesktopPoolRequest) String() string

func (UpdateDesktopPoolRequest) ValidateEnumValue 

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

type UpdateDesktopPoolResponse 

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

UpdateDesktopPoolResponse wrapper for the UpdateDesktopPool operation

func (UpdateDesktopPoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateDesktopPoolResponse) String 

func (response UpdateDesktopPoolResponse) String() string

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

UpdateDesktopRequest wrapper for the UpdateDesktop operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/desktops/UpdateDesktop.go.html to see an example of how to use UpdateDesktopRequest.

func (UpdateDesktopRequest) BinaryRequestBody 

func (request UpdateDesktopRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDesktopRequest) HTTPRequest 

func (request UpdateDesktopRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDesktopRequest) RetryPolicy 

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

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

func (UpdateDesktopRequest) String 

func (request UpdateDesktopRequest) String() string

func (UpdateDesktopRequest) ValidateEnumValue 

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

type UpdateDesktopResponse 

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

UpdateDesktopResponse wrapper for the UpdateDesktop operation

func (UpdateDesktopResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateDesktopResponse) String 

func (response UpdateDesktopResponse) String() string

type WorkRequest 

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

WorkRequest A description of workrequest status.

func (WorkRequest) String 

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue 

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

type WorkRequestError 

type WorkRequestError struct {

	// A machine-usable code for the error that occured. Error codes are listed on
	// (https://docs.cloud.oracle.com/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"`
}

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String 

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue 

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

type WorkRequestErrorCollection 

type WorkRequestErrorCollection struct {

	// List of workRequestError objects.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection Results of a workRequestError search.

func (WorkRequestErrorCollection) String 

func (m WorkRequestErrorCollection) String() string

func (WorkRequestErrorCollection) ValidateEnumValue 

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

type WorkRequestLogEntry 

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

WorkRequestLogEntry A log message from the execution of a work request.

func (WorkRequestLogEntry) String 

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue 

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

type WorkRequestLogEntryCollection 

type WorkRequestLogEntryCollection struct {

	// List of workRequestLogEntries.
	Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

WorkRequestLogEntryCollection Results of a workRequestLog search.

func (WorkRequestLogEntryCollection) String 

func (m WorkRequestLogEntryCollection) String() string

func (WorkRequestLogEntryCollection) ValidateEnumValue 

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

type WorkRequestResource 

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

WorkRequestResource A resource created or operated on by a work request.

func (WorkRequestResource) String 

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue 

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

type WorkRequestSummary 

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

WorkRequestSummary A summary of the status of a work request.

func (WorkRequestSummary) String 

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue 

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

type WorkRequestSummaryCollection 

type WorkRequestSummaryCollection struct {

	// List of workRequestSummary objects.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestSummaryCollection Results of a workRequest search.

func (WorkRequestSummaryCollection) String 

func (m WorkRequestSummaryCollection) String() string

func (WorkRequestSummaryCollection) ValidateEnumValue 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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