func GetCertKeyAlgorithmEnumStringValues() []string
GetCertKeyAlgorithmEnumStringValues Enumerates the set of values in String for CertKeyAlgorithmEnum
func GetCertSignatureAlgorithmEnumStringValues() []string
GetCertSignatureAlgorithmEnumStringValues Enumerates the set of values in String for CertSignatureAlgorithmEnum
func GetClusterTypeEnumStringValues() []string
GetClusterTypeEnumStringValues Enumerates the set of values in String for ClusterTypeEnum
func GetCreateRoverClusterDetailsShippingPreferenceEnumStringValues() []string
GetCreateRoverClusterDetailsShippingPreferenceEnumStringValues Enumerates the set of values in String for CreateRoverClusterDetailsShippingPreferenceEnum
func GetCreateRoverNodeDetailsShippingPreferenceEnumStringValues() []string
GetCreateRoverNodeDetailsShippingPreferenceEnumStringValues Enumerates the set of values in String for CreateRoverNodeDetailsShippingPreferenceEnum
func GetEnclosureTypeEnumStringValues() []string
GetEnclosureTypeEnumStringValues Enumerates the set of values in String for EnclosureTypeEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetListRoverClusterRoverBundleRequestsSortByEnumStringValues() []string
GetListRoverClusterRoverBundleRequestsSortByEnumStringValues Enumerates the set of values in String for ListRoverClusterRoverBundleRequestsSortByEnum
func GetListRoverClusterRoverBundleRequestsSortOrderEnumStringValues() []string
GetListRoverClusterRoverBundleRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListRoverClusterRoverBundleRequestsSortOrderEnum
func GetListRoverClustersClusterTypeEnumStringValues() []string
GetListRoverClustersClusterTypeEnumStringValues Enumerates the set of values in String for ListRoverClustersClusterTypeEnum
func GetListRoverClustersLifecycleStateEnumStringValues() []string
GetListRoverClustersLifecycleStateEnumStringValues Enumerates the set of values in String for ListRoverClustersLifecycleStateEnum
func GetListRoverClustersSortByEnumStringValues() []string
GetListRoverClustersSortByEnumStringValues Enumerates the set of values in String for ListRoverClustersSortByEnum
func GetListRoverClustersSortOrderEnumStringValues() []string
GetListRoverClustersSortOrderEnumStringValues Enumerates the set of values in String for ListRoverClustersSortOrderEnum
func GetListRoverEntitlementsLifecycleStateEnumStringValues() []string
GetListRoverEntitlementsLifecycleStateEnumStringValues Enumerates the set of values in String for ListRoverEntitlementsLifecycleStateEnum
func GetListRoverEntitlementsSortByEnumStringValues() []string
GetListRoverEntitlementsSortByEnumStringValues Enumerates the set of values in String for ListRoverEntitlementsSortByEnum
func GetListRoverEntitlementsSortOrderEnumStringValues() []string
GetListRoverEntitlementsSortOrderEnumStringValues Enumerates the set of values in String for ListRoverEntitlementsSortOrderEnum
func GetListRoverNodeRoverBundleRequestsSortByEnumStringValues() []string
GetListRoverNodeRoverBundleRequestsSortByEnumStringValues Enumerates the set of values in String for ListRoverNodeRoverBundleRequestsSortByEnum
func GetListRoverNodeRoverBundleRequestsSortOrderEnumStringValues() []string
GetListRoverNodeRoverBundleRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListRoverNodeRoverBundleRequestsSortOrderEnum
func GetListRoverNodesLifecycleStateEnumStringValues() []string
GetListRoverNodesLifecycleStateEnumStringValues Enumerates the set of values in String for ListRoverNodesLifecycleStateEnum
func GetListRoverNodesNodeTypeEnumStringValues() []string
GetListRoverNodesNodeTypeEnumStringValues Enumerates the set of values in String for ListRoverNodesNodeTypeEnum
func GetListRoverNodesSortByEnumStringValues() []string
GetListRoverNodesSortByEnumStringValues Enumerates the set of values in String for ListRoverNodesSortByEnum
func GetListRoverNodesSortOrderEnumStringValues() []string
GetListRoverNodesSortOrderEnumStringValues Enumerates the set of values in String for ListRoverNodesSortOrderEnum
func GetListShapesSortByEnumStringValues() []string
GetListShapesSortByEnumStringValues Enumerates the set of values in String for ListShapesSortByEnum
func GetListShapesSortOrderEnumStringValues() []string
GetListShapesSortOrderEnumStringValues Enumerates the set of values in String for ListShapesSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsOperationTypeEnumStringValues() []string
GetListWorkRequestsOperationTypeEnumStringValues Enumerates the set of values in String for ListWorkRequestsOperationTypeEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetNodeTypeEnumStringValues() []string
GetNodeTypeEnumStringValues Enumerates the set of values in String for NodeTypeEnum
func GetRoverBundleStatusStatusEnumStringValues() []string
GetRoverBundleStatusStatusEnumStringValues Enumerates the set of values in String for RoverBundleStatusStatusEnum
func GetRoverClusterShippingPreferenceEnumStringValues() []string
GetRoverClusterShippingPreferenceEnumStringValues Enumerates the set of values in String for RoverClusterShippingPreferenceEnum
func GetRoverEntitlementLifecycleStateEnumStringValues() []string
GetRoverEntitlementLifecycleStateEnumStringValues Enumerates the set of values in String for RoverEntitlementLifecycleStateEnum
func GetRoverNodeShippingPreferenceEnumStringValues() []string
GetRoverNodeShippingPreferenceEnumStringValues Enumerates the set of values in String for RoverNodeShippingPreferenceEnum
func GetSortOrdersEnumStringValues() []string
GetSortOrdersEnumStringValues Enumerates the set of values in String for SortOrdersEnum
func GetUpdateRoverClusterDetailsShippingPreferenceEnumStringValues() []string
GetUpdateRoverClusterDetailsShippingPreferenceEnumStringValues Enumerates the set of values in String for UpdateRoverClusterDetailsShippingPreferenceEnum
func GetUpdateRoverNodeDetailsShippingPreferenceEnumStringValues() []string
GetUpdateRoverNodeDetailsShippingPreferenceEnumStringValues Enumerates the set of values in String for UpdateRoverNodeDetailsShippingPreferenceEnum
func GetWorkRequestOperationStatusEnumStringValues() []string
GetWorkRequestOperationStatusEnumStringValues Enumerates the set of values in String for WorkRequestOperationStatusEnum
func GetWorkRequestOperationTypeEnumStringValues() []string
GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum
func GetWorkRequestResourceActionTypeEnumStringValues() []string
GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum
CaBundleResponse Information about the CA Bundle of the rover node.
type CaBundleResponse struct {
// rover node ocid
RoverNodeId *string `mandatory:"true" json:"roverNodeId"`
CaDetails *CaDetails `mandatory:"false" json:"caDetails"`
}
func (m CaBundleResponse) String() string
func (m CaBundleResponse) 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
CaDetails Information about the detailed CA bundle content of the rover node.
type CaDetails struct {
// Plain text certificate chain in PEM format for the subordinate CA associated with given roverNode.
CaBundlePem *string `mandatory:"false" json:"caBundlePem"`
// Max validity of leaf certificates issued by the CA associated with given node, in days, in ISO 8601 format, example "P365D".
CertificateMaxValidityDuration *string `mandatory:"false" json:"certificateMaxValidityDuration"`
}
func (m CaDetails) String() string
func (m CaDetails) 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
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The ocid of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
CertKeyAlgorithmEnum Enum with underlying type: string
type CertKeyAlgorithmEnum string
Set of constants representing the allowable values for CertKeyAlgorithmEnum
const (
CertKeyAlgorithmRsa2048 CertKeyAlgorithmEnum = "RSA2048"
CertKeyAlgorithmRsa4096 CertKeyAlgorithmEnum = "RSA4096"
CertKeyAlgorithmEcdsaP256 CertKeyAlgorithmEnum = "ECDSA_P256"
CertKeyAlgorithmEcdsaP384 CertKeyAlgorithmEnum = "ECDSA_P384"
)
func GetCertKeyAlgorithmEnumValues() []CertKeyAlgorithmEnum
GetCertKeyAlgorithmEnumValues Enumerates the set of values for CertKeyAlgorithmEnum
func GetMappingCertKeyAlgorithmEnum(val string) (CertKeyAlgorithmEnum, bool)
GetMappingCertKeyAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
CertSignatureAlgorithmEnum Enum with underlying type: string
type CertSignatureAlgorithmEnum string
Set of constants representing the allowable values for CertSignatureAlgorithmEnum
const (
CertSignatureAlgorithmSha256WithRsa CertSignatureAlgorithmEnum = "SHA256_WITH_RSA"
CertSignatureAlgorithmSha384WithRsa CertSignatureAlgorithmEnum = "SHA384_WITH_RSA"
CertSignatureAlgorithmSha512WithRsa CertSignatureAlgorithmEnum = "SHA512_WITH_RSA"
CertSignatureAlgorithmSha256WithEcdsa CertSignatureAlgorithmEnum = "SHA256_WITH_ECDSA"
CertSignatureAlgorithmSha384WithEcdsa CertSignatureAlgorithmEnum = "SHA384_WITH_ECDSA"
CertSignatureAlgorithmSha512WithEcdsa CertSignatureAlgorithmEnum = "SHA512_WITH_ECDSA"
)
func GetCertSignatureAlgorithmEnumValues() []CertSignatureAlgorithmEnum
GetCertSignatureAlgorithmEnumValues Enumerates the set of values for CertSignatureAlgorithmEnum
func GetMappingCertSignatureAlgorithmEnum(val string) (CertSignatureAlgorithmEnum, bool)
GetMappingCertSignatureAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
CertificateDetails The details of Oracle Cloud Infrastructure certificate created
type CertificateDetails struct {
// The id of the certificate.
CertificateId *string `mandatory:"false" json:"certificateId"`
// The name of the certificate.
CertificateName *string `mandatory:"false" json:"certificateName"`
}
func (m CertificateDetails) String() string
func (m CertificateDetails) 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
ChangeRoverClusterCompartmentDetails Object for moving a cluster to a different compartment.
type ChangeRoverClusterCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resources should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeRoverClusterCompartmentDetails) String() string
func (m ChangeRoverClusterCompartmentDetails) 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
ChangeRoverClusterCompartmentRequest wrapper for the ChangeRoverClusterCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ChangeRoverClusterCompartment.go.html to see an example of how to use ChangeRoverClusterCompartmentRequest.
type ChangeRoverClusterCompartmentRequest struct {
// Unique RoverCluster identifier
RoverClusterId *string `mandatory:"true" contributesTo:"path" name:"roverClusterId"`
// CompartmentId of the destination compartment
ChangeRoverClusterCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeRoverClusterCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeRoverClusterCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeRoverClusterCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeRoverClusterCompartmentRequest) String() string
func (request ChangeRoverClusterCompartmentRequest) 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
ChangeRoverClusterCompartmentResponse wrapper for the ChangeRoverClusterCompartment operation
type ChangeRoverClusterCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeRoverClusterCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeRoverClusterCompartmentResponse) String() string
ChangeRoverEntitlementCompartmentDetails Object for moving an entitlement to a different compartment.
type ChangeRoverEntitlementCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resources should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeRoverEntitlementCompartmentDetails) String() string
func (m ChangeRoverEntitlementCompartmentDetails) 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
ChangeRoverEntitlementCompartmentRequest wrapper for the ChangeRoverEntitlementCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ChangeRoverEntitlementCompartment.go.html to see an example of how to use ChangeRoverEntitlementCompartmentRequest.
type ChangeRoverEntitlementCompartmentRequest struct {
// ID of the rover node or cluster entitlement
RoverEntitlementId *string `mandatory:"true" contributesTo:"path" name:"roverEntitlementId"`
// CompartmentId of the destination compartment
ChangeRoverEntitlementCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeRoverEntitlementCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeRoverEntitlementCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeRoverEntitlementCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeRoverEntitlementCompartmentRequest) String() string
func (request ChangeRoverEntitlementCompartmentRequest) 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
ChangeRoverEntitlementCompartmentResponse wrapper for the ChangeRoverEntitlementCompartment operation
type ChangeRoverEntitlementCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeRoverEntitlementCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeRoverEntitlementCompartmentResponse) String() string
ChangeRoverNodeCompartmentDetails Object for moving a node to a different compartment.
type ChangeRoverNodeCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resources should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeRoverNodeCompartmentDetails) String() string
func (m ChangeRoverNodeCompartmentDetails) 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
ChangeRoverNodeCompartmentRequest wrapper for the ChangeRoverNodeCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ChangeRoverNodeCompartment.go.html to see an example of how to use ChangeRoverNodeCompartmentRequest.
type ChangeRoverNodeCompartmentRequest struct {
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// CompartmentId of the destination compartment
ChangeRoverNodeCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeRoverNodeCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeRoverNodeCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeRoverNodeCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeRoverNodeCompartmentRequest) String() string
func (request ChangeRoverNodeCompartmentRequest) 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
ChangeRoverNodeCompartmentResponse wrapper for the ChangeRoverNodeCompartment operation
type ChangeRoverNodeCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeRoverNodeCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeRoverNodeCompartmentResponse) String() string
ClusterTypeEnum Enum with underlying type: string
type ClusterTypeEnum string
Set of constants representing the allowable values for ClusterTypeEnum
const (
ClusterTypeStandalone ClusterTypeEnum = "STANDALONE"
ClusterTypeStation ClusterTypeEnum = "STATION"
)
func GetClusterTypeEnumValues() []ClusterTypeEnum
GetClusterTypeEnumValues Enumerates the set of values for ClusterTypeEnum
func GetMappingClusterTypeEnum(val string) (ClusterTypeEnum, bool)
GetMappingClusterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateRoverClusterDetails The information required to create a RoverCluster.
type CreateRoverClusterDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment containing the RoverCluster.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Number of nodes desired in the cluster, in standalone clusters, between 5 and 15 inclusive. In station clusters, between 15 and 30 inclusive.
ClusterSize *int `mandatory:"true" json:"clusterSize"`
CustomerShippingAddress *ShippingAddress `mandatory:"false" json:"customerShippingAddress"`
// List of existing workloads that should be provisioned on the nodes.
ClusterWorkloads []RoverWorkload `mandatory:"false" json:"clusterWorkloads"`
// Type of cluster.
ClusterType ClusterTypeEnum `mandatory:"false" json:"clusterType,omitempty"`
// Root password for the rover cluster.
SuperUserPassword *string `mandatory:"false" json:"superUserPassword"`
// The type of enclosure rover nodes in this cluster are shipped in.
EnclosureType EnclosureTypeEnum `mandatory:"false" json:"enclosureType,omitempty"`
// Password to unlock the rover cluster.
UnlockPassphrase *string `mandatory:"false" json:"unlockPassphrase"`
// Name of point of contact for this order if customer is picking up.
PointOfContact *string `mandatory:"false" json:"pointOfContact"`
// Phone number of point of contact for this order if customer is picking up.
PointOfContactPhoneNumber *string `mandatory:"false" json:"pointOfContactPhoneNumber"`
// Preference for device delivery.
ShippingPreference CreateRoverClusterDetailsShippingPreferenceEnum `mandatory:"false" json:"shippingPreference,omitempty"`
// Shipping vendor of choice for orace to customer shipping.
ShippingVendor *string `mandatory:"false" json:"shippingVendor"`
// Expected date when customer wants to pickup the cluster if they chose customer pickup.
TimePickupExpected *common.SDKTime `mandatory:"false" json:"timePickupExpected"`
// Tracking Url for the shipped Rover Cluster.
OracleShippingTrackingUrl *string `mandatory:"false" json:"oracleShippingTrackingUrl"`
// ID provided to customer after successful subscription to Rover Stations.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// The current state of the RoverCluster.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A property that can contain details on the lifecycle.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// The flag indicating that customer requests data to be imported to OCI upon Rover cluster return.
IsImportRequested *bool `mandatory:"false" json:"isImportRequested"`
// An OCID of a compartment where data will be imported to upon Rover cluster return.
ImportCompartmentId *string `mandatory:"false" json:"importCompartmentId"`
// Name of a bucket where files from NFS share will be imported to upon Rover cluster return.
ImportFileBucket *string `mandatory:"false" json:"importFileBucket"`
// Validation code returned by data validation tool. Required for return shipping label generation if data import was requested.
DataValidationCode *string `mandatory:"false" json:"dataValidationCode"`
// Customer provided master key ID to encrypt secret information. If not provided, Rover's master key will be used for encryption.
MasterKeyId *string `mandatory:"false" json:"masterKeyId"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m CreateRoverClusterDetails) String() string
func (m CreateRoverClusterDetails) 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
CreateRoverClusterDetailsShippingPreferenceEnum Enum with underlying type: string
type CreateRoverClusterDetailsShippingPreferenceEnum string
Set of constants representing the allowable values for CreateRoverClusterDetailsShippingPreferenceEnum
const (
CreateRoverClusterDetailsShippingPreferenceOracleShipped CreateRoverClusterDetailsShippingPreferenceEnum = "ORACLE_SHIPPED"
CreateRoverClusterDetailsShippingPreferenceCustomerPickup CreateRoverClusterDetailsShippingPreferenceEnum = "CUSTOMER_PICKUP"
)
func GetCreateRoverClusterDetailsShippingPreferenceEnumValues() []CreateRoverClusterDetailsShippingPreferenceEnum
GetCreateRoverClusterDetailsShippingPreferenceEnumValues Enumerates the set of values for CreateRoverClusterDetailsShippingPreferenceEnum
func GetMappingCreateRoverClusterDetailsShippingPreferenceEnum(val string) (CreateRoverClusterDetailsShippingPreferenceEnum, bool)
GetMappingCreateRoverClusterDetailsShippingPreferenceEnum performs case Insensitive comparison on enum value and return the desired enum
CreateRoverClusterRequest wrapper for the CreateRoverCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/CreateRoverCluster.go.html to see an example of how to use CreateRoverClusterRequest.
type CreateRoverClusterRequest struct {
// Details for the new RoverCluster.
CreateRoverClusterDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateRoverClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRoverClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRoverClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRoverClusterRequest) String() string
func (request CreateRoverClusterRequest) 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
CreateRoverClusterResponse wrapper for the CreateRoverCluster operation
type CreateRoverClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverCluster instance
RoverCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateRoverClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRoverClusterResponse) String() string
CreateRoverEntitlementDetails Information required to create a RoverEntitlement.
type CreateRoverEntitlementDetails struct {
// The OCID of the compartment containing the RoverEntitlement.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Requestor name for the entitlement.
RequestorName *string `mandatory:"true" json:"requestorName"`
// Requestor email for the entitlement.
RequestorEmail *string `mandatory:"true" json:"requestorEmail"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Details about the entitlement.
EntitlementDetails *string `mandatory:"false" json:"entitlementDetails"`
// The current state of the RoverNode.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A property that can contain details on the lifecycle.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// tenant Id.
TenantId *string `mandatory:"false" json:"tenantId"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m CreateRoverEntitlementDetails) String() string
func (m CreateRoverEntitlementDetails) 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
CreateRoverEntitlementRequest wrapper for the CreateRoverEntitlement operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/CreateRoverEntitlement.go.html to see an example of how to use CreateRoverEntitlementRequest.
type CreateRoverEntitlementRequest struct {
// Creates a Rover Device Entitlement
CreateRoverEntitlementDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateRoverEntitlementRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRoverEntitlementRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRoverEntitlementRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRoverEntitlementRequest) String() string
func (request CreateRoverEntitlementRequest) 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
CreateRoverEntitlementResponse wrapper for the CreateRoverEntitlement operation
type CreateRoverEntitlementResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverEntitlement instance
RoverEntitlement `presentIn:"body"`
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateRoverEntitlementResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRoverEntitlementResponse) String() string
CreateRoverNodeDetails The information required to create a RoverNode.
type CreateRoverNodeDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment containing the RoverNode.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The shape of the node.
Shape *string `mandatory:"false" json:"shape"`
CustomerShippingAddress *ShippingAddress `mandatory:"false" json:"customerShippingAddress"`
// List of existing workloads that should be provisioned on the node.
NodeWorkloads []RoverWorkload `mandatory:"false" json:"nodeWorkloads"`
// Root password for the rover node.
SuperUserPassword *string `mandatory:"false" json:"superUserPassword"`
// Passphrase to unlock the rover node.
UnlockPassphrase *string `mandatory:"false" json:"unlockPassphrase"`
// Name of point of contact for this order if customer is picking up.
PointOfContact *string `mandatory:"false" json:"pointOfContact"`
// Phone number of point of contact for this order if customer is picking up.
PointOfContactPhoneNumber *string `mandatory:"false" json:"pointOfContactPhoneNumber"`
// Preference for device delivery.
ShippingPreference CreateRoverNodeDetailsShippingPreferenceEnum `mandatory:"false" json:"shippingPreference,omitempty"`
// Shipping vendor of choice for orace to customer shipping.
ShippingVendor *string `mandatory:"false" json:"shippingVendor"`
// Expected date when customer wants to pickup the device if they chose customer pickup.
TimePickupExpected *common.SDKTime `mandatory:"false" json:"timePickupExpected"`
// The public key of the resource principal
PublicKey *string `mandatory:"false" json:"publicKey"`
// Start time for the window to pickup the device from customer.
TimeReturnWindowStarts *common.SDKTime `mandatory:"false" json:"timeReturnWindowStarts"`
// End time for the window to pickup the device from customer.
TimeReturnWindowEnds *common.SDKTime `mandatory:"false" json:"timeReturnWindowEnds"`
// The current state of the RoverNode.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The type of enclosure rover nodes in this cluster are shipped in.
EnclosureType EnclosureTypeEnum `mandatory:"false" json:"enclosureType,omitempty"`
// A property that can contain details on the lifecycle.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// Serial number of the node.
SerialNumber *string `mandatory:"false" json:"serialNumber"`
// Tracking Url for the shipped FmsRoverNode.
OracleShippingTrackingUrl *string `mandatory:"false" json:"oracleShippingTrackingUrl"`
// The flag indicating that customer requests data to be imported to OCI upon Rover node return.
IsImportRequested *bool `mandatory:"false" json:"isImportRequested"`
// An OCID of a compartment where data will be imported to upon Rover node return.
ImportCompartmentId *string `mandatory:"false" json:"importCompartmentId"`
// Name of a bucket where files from NFS share will be imported to upon Rover node return.
ImportFileBucket *string `mandatory:"false" json:"importFileBucket"`
// Validation code returned by data validation tool. Required for return shipping label generation if data import was requested.
DataValidationCode *string `mandatory:"false" json:"dataValidationCode"`
// Customer provided master key ID to encrypt secret information. If not provided, Rover's master key will be used for encryption.
MasterKeyId *string `mandatory:"false" json:"masterKeyId"`
// The certificateAuthorityId of subordinate/intermediate certificate authority.
CertificateAuthorityId *string `mandatory:"false" json:"certificateAuthorityId"`
// The time after which leaf certificate will invalid.
TimeCertValidityEnd *common.SDKTime `mandatory:"false" json:"timeCertValidityEnd"`
// The common name for the leaf certificate.
CommonName *string `mandatory:"false" json:"commonName"`
// The compartmentId of the leaf certificate.
CertCompartmentId *string `mandatory:"false" json:"certCompartmentId"`
// key algorithm for issuing leaf certificate.
CertKeyAlgorithm CertKeyAlgorithmEnum `mandatory:"false" json:"certKeyAlgorithm,omitempty"`
// signature algorithm for issuing leaf certificate.
CertSignatureAlgorithm CertSignatureAlgorithmEnum `mandatory:"false" json:"certSignatureAlgorithm,omitempty"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m CreateRoverNodeDetails) String() string
func (m CreateRoverNodeDetails) 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
CreateRoverNodeDetailsShippingPreferenceEnum Enum with underlying type: string
type CreateRoverNodeDetailsShippingPreferenceEnum string
Set of constants representing the allowable values for CreateRoverNodeDetailsShippingPreferenceEnum
const (
CreateRoverNodeDetailsShippingPreferenceOracleShipped CreateRoverNodeDetailsShippingPreferenceEnum = "ORACLE_SHIPPED"
CreateRoverNodeDetailsShippingPreferenceCustomerPickup CreateRoverNodeDetailsShippingPreferenceEnum = "CUSTOMER_PICKUP"
)
func GetCreateRoverNodeDetailsShippingPreferenceEnumValues() []CreateRoverNodeDetailsShippingPreferenceEnum
GetCreateRoverNodeDetailsShippingPreferenceEnumValues Enumerates the set of values for CreateRoverNodeDetailsShippingPreferenceEnum
func GetMappingCreateRoverNodeDetailsShippingPreferenceEnum(val string) (CreateRoverNodeDetailsShippingPreferenceEnum, bool)
GetMappingCreateRoverNodeDetailsShippingPreferenceEnum performs case Insensitive comparison on enum value and return the desired enum
CreateRoverNodeRequest wrapper for the CreateRoverNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/CreateRoverNode.go.html to see an example of how to use CreateRoverNodeRequest.
type CreateRoverNodeRequest struct {
// Details for the new RoverNode.
CreateRoverNodeDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateRoverNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRoverNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRoverNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRoverNodeRequest) String() string
func (request CreateRoverNodeRequest) 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
CreateRoverNodeResponse wrapper for the CreateRoverNode operation
type CreateRoverNodeResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverNode instance
RoverNode `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateRoverNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRoverNodeResponse) String() string
CurrentRoverBundleDetails Information required to list all available valid rover bundle versions that can be upgraded based on current bundle version.
type CurrentRoverBundleDetails struct {
// The version of current rover bundle on customer's roverNode or roverCluster device.
CurrentRoverBundleVersion *string `mandatory:"true" json:"currentRoverBundleVersion"`
}
func (m CurrentRoverBundleDetails) String() string
func (m CurrentRoverBundleDetails) 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
DeleteRoverClusterRequest wrapper for the DeleteRoverCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/DeleteRoverCluster.go.html to see an example of how to use DeleteRoverClusterRequest.
type DeleteRoverClusterRequest struct {
// Unique RoverCluster identifier
RoverClusterId *string `mandatory:"true" contributesTo:"path" name:"roverClusterId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteRoverClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteRoverClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRoverClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRoverClusterRequest) String() string
func (request DeleteRoverClusterRequest) 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
DeleteRoverClusterResponse wrapper for the DeleteRoverCluster operation
type DeleteRoverClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteRoverClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRoverClusterResponse) String() string
DeleteRoverEntitlementRequest wrapper for the DeleteRoverEntitlement operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/DeleteRoverEntitlement.go.html to see an example of how to use DeleteRoverEntitlementRequest.
type DeleteRoverEntitlementRequest struct {
// ID of the rover node or cluster entitlement
RoverEntitlementId *string `mandatory:"true" contributesTo:"path" name:"roverEntitlementId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteRoverEntitlementRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteRoverEntitlementRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRoverEntitlementRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRoverEntitlementRequest) String() string
func (request DeleteRoverEntitlementRequest) 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
DeleteRoverEntitlementResponse wrapper for the DeleteRoverEntitlement operation
type DeleteRoverEntitlementResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteRoverEntitlementResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRoverEntitlementResponse) String() string
DeleteRoverNodeRequest wrapper for the DeleteRoverNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/DeleteRoverNode.go.html to see an example of how to use DeleteRoverNodeRequest.
type DeleteRoverNodeRequest struct {
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteRoverNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteRoverNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRoverNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRoverNodeRequest) String() string
func (request DeleteRoverNodeRequest) 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
DeleteRoverNodeResponse wrapper for the DeleteRoverNode operation
type DeleteRoverNodeResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteRoverNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRoverNodeResponse) String() string
EnclosureTypeEnum Enum with underlying type: string
type EnclosureTypeEnum string
Set of constants representing the allowable values for EnclosureTypeEnum
const (
EnclosureTypeRuggadized EnclosureTypeEnum = "RUGGADIZED"
EnclosureTypeNonRuggadized EnclosureTypeEnum = "NON_RUGGADIZED"
)
func GetEnclosureTypeEnumValues() []EnclosureTypeEnum
GetEnclosureTypeEnumValues Enumerates the set of values for EnclosureTypeEnum
func GetMappingEnclosureTypeEnum(val string) (EnclosureTypeEnum, bool)
GetMappingEnclosureTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GenerateCertificateResponse The information of rover node certificate generated by Oracle Cloud Infrastructure certificate service.
type GenerateCertificateResponse struct {
// The id of the rover node.
RoverNodeId *string `mandatory:"true" json:"roverNodeId"`
CertificateDetails *CertificateDetails `mandatory:"false" json:"certificateDetails"`
}
func (m GenerateCertificateResponse) String() string
func (m GenerateCertificateResponse) 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
GetRoverClusterCertificateRequest wrapper for the GetRoverClusterCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverClusterCertificate.go.html to see an example of how to use GetRoverClusterCertificateRequest.
type GetRoverClusterCertificateRequest struct {
// Unique RoverCluster identifier
RoverClusterId *string `mandatory:"true" contributesTo:"path" name:"roverClusterId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetRoverClusterCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRoverClusterCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRoverClusterCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRoverClusterCertificateRequest) String() string
func (request GetRoverClusterCertificateRequest) 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
GetRoverClusterCertificateResponse wrapper for the GetRoverClusterCertificate operation
type GetRoverClusterCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverClusterCertificate instance
RoverClusterCertificate `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetRoverClusterCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRoverClusterCertificateResponse) String() string
GetRoverClusterRequest wrapper for the GetRoverCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverCluster.go.html to see an example of how to use GetRoverClusterRequest.
type GetRoverClusterRequest struct {
// Unique RoverCluster identifier
RoverClusterId *string `mandatory:"true" contributesTo:"path" name:"roverClusterId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetRoverClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRoverClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRoverClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRoverClusterRequest) String() string
func (request GetRoverClusterRequest) 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
GetRoverClusterResponse wrapper for the GetRoverCluster operation
type GetRoverClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverCluster instance
RoverCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetRoverClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRoverClusterResponse) String() string
GetRoverEntitlementRequest wrapper for the GetRoverEntitlement operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverEntitlement.go.html to see an example of how to use GetRoverEntitlementRequest.
type GetRoverEntitlementRequest struct {
// ID of the rover node or cluster entitlement
RoverEntitlementId *string `mandatory:"true" contributesTo:"path" name:"roverEntitlementId"`
// The OCID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetRoverEntitlementRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRoverEntitlementRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRoverEntitlementRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRoverEntitlementRequest) String() string
func (request GetRoverEntitlementRequest) 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
GetRoverEntitlementResponse wrapper for the GetRoverEntitlement operation
type GetRoverEntitlementResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverEntitlement instance
RoverEntitlement `presentIn:"body"`
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetRoverEntitlementResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRoverEntitlementResponse) String() string
GetRoverNodeCertificateRequest wrapper for the GetRoverNodeCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverNodeCertificate.go.html to see an example of how to use GetRoverNodeCertificateRequest.
type GetRoverNodeCertificateRequest struct {
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetRoverNodeCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRoverNodeCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRoverNodeCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRoverNodeCertificateRequest) String() string
func (request GetRoverNodeCertificateRequest) 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
GetRoverNodeCertificateResponse wrapper for the GetRoverNodeCertificate operation
type GetRoverNodeCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverNodeCertificate instance
RoverNodeCertificate `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetRoverNodeCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRoverNodeCertificateResponse) String() string
GetRoverNodeEncryptionKeyRequest wrapper for the GetRoverNodeEncryptionKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverNodeEncryptionKey.go.html to see an example of how to use GetRoverNodeEncryptionKeyRequest.
type GetRoverNodeEncryptionKeyRequest struct {
// Serial number of the rover node.
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetRoverNodeEncryptionKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRoverNodeEncryptionKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRoverNodeEncryptionKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRoverNodeEncryptionKeyRequest) String() string
func (request GetRoverNodeEncryptionKeyRequest) 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
GetRoverNodeEncryptionKeyResponse wrapper for the GetRoverNodeEncryptionKey operation
type GetRoverNodeEncryptionKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverNodeEncryptionKey instance
RoverNodeEncryptionKey `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetRoverNodeEncryptionKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRoverNodeEncryptionKeyResponse) String() string
GetRoverNodeGetRptRequest wrapper for the GetRoverNodeGetRpt operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverNodeGetRpt.go.html to see an example of how to use GetRoverNodeGetRptRequest.
type GetRoverNodeGetRptRequest struct {
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The Java Web Token which is a signature of the request that is signed with the resource's private key
// This is meant solely in the context of getRpt
Jwt *string `mandatory:"true" contributesTo:"header" name:"jwt"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetRoverNodeGetRptRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRoverNodeGetRptRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRoverNodeGetRptRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRoverNodeGetRptRequest) String() string
func (request GetRoverNodeGetRptRequest) 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
GetRoverNodeGetRptResponse wrapper for the GetRoverNodeGetRpt operation
type GetRoverNodeGetRptResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverNodeGetRpt instance
RoverNodeGetRpt `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetRoverNodeGetRptResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRoverNodeGetRptResponse) String() string
GetRoverNodeRequest wrapper for the GetRoverNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverNode.go.html to see an example of how to use GetRoverNodeRequest.
type GetRoverNodeRequest struct {
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetRoverNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRoverNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRoverNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRoverNodeRequest) String() string
func (request GetRoverNodeRequest) 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
GetRoverNodeResponse wrapper for the GetRoverNode operation
type GetRoverNodeResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverNode instance
RoverNode `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetRoverNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRoverNodeResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ocid of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
LeafCertificateDetails The details of leaf certificate
type LeafCertificateDetails struct {
// The id of the certificate
CertificateId *string `mandatory:"false" json:"certificateId"`
// The certificate content in PEM format
CertificatePem *string `mandatory:"false" json:"certificatePem"`
}
func (m LeafCertificateDetails) String() string
func (m LeafCertificateDetails) 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
LeafCertificateResponse The information for a left certificate for a rover node
type LeafCertificateResponse struct {
// The id of the rover node.
RoverNodeId *string `mandatory:"true" json:"roverNodeId"`
LeafCertificateDetails *LeafCertificateDetails `mandatory:"false" json:"leafCertificateDetails"`
}
func (m LeafCertificateResponse) String() string
func (m LeafCertificateResponse) 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
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum
const (
LifecycleStateCreating LifecycleStateEnum = "CREATING"
LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateDeleting LifecycleStateEnum = "DELETING"
LifecycleStateDeleted LifecycleStateEnum = "DELETED"
LifecycleStateFailed LifecycleStateEnum = "FAILED"
)
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverClusterRoverBundleRequestsRequest wrapper for the ListRoverClusterRoverBundleRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListRoverClusterRoverBundleRequests.go.html to see an example of how to use ListRoverClusterRoverBundleRequestsRequest.
type ListRoverClusterRoverBundleRequestsRequest struct {
// Unique RoverCluster identifier
RoverClusterId *string `mandatory:"true" contributesTo:"path" name:"roverClusterId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListRoverClusterRoverBundleRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeTaskCreated is descending. If no value is specified timeTaskCreated is default.
SortBy ListRoverClusterRoverBundleRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRoverClusterRoverBundleRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRoverClusterRoverBundleRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRoverClusterRoverBundleRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRoverClusterRoverBundleRequestsRequest) String() string
func (request ListRoverClusterRoverBundleRequestsRequest) 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
ListRoverClusterRoverBundleRequestsResponse wrapper for the ListRoverClusterRoverBundleRequests operation
type ListRoverClusterRoverBundleRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RoverBundleRequestCollection instances
RoverBundleRequestCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListRoverClusterRoverBundleRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRoverClusterRoverBundleRequestsResponse) String() string
ListRoverClusterRoverBundleRequestsSortByEnum Enum with underlying type: string
type ListRoverClusterRoverBundleRequestsSortByEnum string
Set of constants representing the allowable values for ListRoverClusterRoverBundleRequestsSortByEnum
const (
ListRoverClusterRoverBundleRequestsSortByTimetaskcreated ListRoverClusterRoverBundleRequestsSortByEnum = "timeTaskCreated"
)
func GetListRoverClusterRoverBundleRequestsSortByEnumValues() []ListRoverClusterRoverBundleRequestsSortByEnum
GetListRoverClusterRoverBundleRequestsSortByEnumValues Enumerates the set of values for ListRoverClusterRoverBundleRequestsSortByEnum
func GetMappingListRoverClusterRoverBundleRequestsSortByEnum(val string) (ListRoverClusterRoverBundleRequestsSortByEnum, bool)
GetMappingListRoverClusterRoverBundleRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverClusterRoverBundleRequestsSortOrderEnum Enum with underlying type: string
type ListRoverClusterRoverBundleRequestsSortOrderEnum string
Set of constants representing the allowable values for ListRoverClusterRoverBundleRequestsSortOrderEnum
const (
ListRoverClusterRoverBundleRequestsSortOrderAsc ListRoverClusterRoverBundleRequestsSortOrderEnum = "ASC"
ListRoverClusterRoverBundleRequestsSortOrderDesc ListRoverClusterRoverBundleRequestsSortOrderEnum = "DESC"
)
func GetListRoverClusterRoverBundleRequestsSortOrderEnumValues() []ListRoverClusterRoverBundleRequestsSortOrderEnum
GetListRoverClusterRoverBundleRequestsSortOrderEnumValues Enumerates the set of values for ListRoverClusterRoverBundleRequestsSortOrderEnum
func GetMappingListRoverClusterRoverBundleRequestsSortOrderEnum(val string) (ListRoverClusterRoverBundleRequestsSortOrderEnum, bool)
GetMappingListRoverClusterRoverBundleRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverClustersClusterTypeEnum Enum with underlying type: string
type ListRoverClustersClusterTypeEnum string
Set of constants representing the allowable values for ListRoverClustersClusterTypeEnum
const (
ListRoverClustersClusterTypeStandalone ListRoverClustersClusterTypeEnum = "STANDALONE"
ListRoverClustersClusterTypeStation ListRoverClustersClusterTypeEnum = "STATION"
)
func GetListRoverClustersClusterTypeEnumValues() []ListRoverClustersClusterTypeEnum
GetListRoverClustersClusterTypeEnumValues Enumerates the set of values for ListRoverClustersClusterTypeEnum
func GetMappingListRoverClustersClusterTypeEnum(val string) (ListRoverClustersClusterTypeEnum, bool)
GetMappingListRoverClustersClusterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverClustersLifecycleStateEnum Enum with underlying type: string
type ListRoverClustersLifecycleStateEnum string
Set of constants representing the allowable values for ListRoverClustersLifecycleStateEnum
const (
ListRoverClustersLifecycleStateCreating ListRoverClustersLifecycleStateEnum = "CREATING"
ListRoverClustersLifecycleStateUpdating ListRoverClustersLifecycleStateEnum = "UPDATING"
ListRoverClustersLifecycleStateActive ListRoverClustersLifecycleStateEnum = "ACTIVE"
ListRoverClustersLifecycleStateDeleting ListRoverClustersLifecycleStateEnum = "DELETING"
ListRoverClustersLifecycleStateDeleted ListRoverClustersLifecycleStateEnum = "DELETED"
ListRoverClustersLifecycleStateFailed ListRoverClustersLifecycleStateEnum = "FAILED"
)
func GetListRoverClustersLifecycleStateEnumValues() []ListRoverClustersLifecycleStateEnum
GetListRoverClustersLifecycleStateEnumValues Enumerates the set of values for ListRoverClustersLifecycleStateEnum
func GetMappingListRoverClustersLifecycleStateEnum(val string) (ListRoverClustersLifecycleStateEnum, bool)
GetMappingListRoverClustersLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverClustersRequest wrapper for the ListRoverClusters operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListRoverClusters.go.html to see an example of how to use ListRoverClustersRequest.
type ListRoverClustersRequest struct {
// The OCID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only Clusters of type matched with the given cluster type.
ClusterType ListRoverClustersClusterTypeEnum `mandatory:"false" contributesTo:"query" name:"clusterType" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState ListRoverClustersLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListRoverClustersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
SortBy ListRoverClustersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRoverClustersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRoverClustersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRoverClustersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRoverClustersRequest) String() string
func (request ListRoverClustersRequest) 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
ListRoverClustersResponse wrapper for the ListRoverClusters operation
type ListRoverClustersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RoverClusterCollection instances
RoverClusterCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the previous batch of items.
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListRoverClustersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRoverClustersResponse) String() string
ListRoverClustersSortByEnum Enum with underlying type: string
type ListRoverClustersSortByEnum string
Set of constants representing the allowable values for ListRoverClustersSortByEnum
const (
ListRoverClustersSortByTimecreated ListRoverClustersSortByEnum = "timeCreated"
ListRoverClustersSortByDisplayname ListRoverClustersSortByEnum = "displayName"
)
func GetListRoverClustersSortByEnumValues() []ListRoverClustersSortByEnum
GetListRoverClustersSortByEnumValues Enumerates the set of values for ListRoverClustersSortByEnum
func GetMappingListRoverClustersSortByEnum(val string) (ListRoverClustersSortByEnum, bool)
GetMappingListRoverClustersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverClustersSortOrderEnum Enum with underlying type: string
type ListRoverClustersSortOrderEnum string
Set of constants representing the allowable values for ListRoverClustersSortOrderEnum
const (
ListRoverClustersSortOrderAsc ListRoverClustersSortOrderEnum = "ASC"
ListRoverClustersSortOrderDesc ListRoverClustersSortOrderEnum = "DESC"
)
func GetListRoverClustersSortOrderEnumValues() []ListRoverClustersSortOrderEnum
GetListRoverClustersSortOrderEnumValues Enumerates the set of values for ListRoverClustersSortOrderEnum
func GetMappingListRoverClustersSortOrderEnum(val string) (ListRoverClustersSortOrderEnum, bool)
GetMappingListRoverClustersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverEntitlementsLifecycleStateEnum Enum with underlying type: string
type ListRoverEntitlementsLifecycleStateEnum string
Set of constants representing the allowable values for ListRoverEntitlementsLifecycleStateEnum
const (
ListRoverEntitlementsLifecycleStateCreating ListRoverEntitlementsLifecycleStateEnum = "CREATING"
ListRoverEntitlementsLifecycleStateUpdating ListRoverEntitlementsLifecycleStateEnum = "UPDATING"
ListRoverEntitlementsLifecycleStateActive ListRoverEntitlementsLifecycleStateEnum = "ACTIVE"
ListRoverEntitlementsLifecycleStateDeleting ListRoverEntitlementsLifecycleStateEnum = "DELETING"
ListRoverEntitlementsLifecycleStateDeleted ListRoverEntitlementsLifecycleStateEnum = "DELETED"
ListRoverEntitlementsLifecycleStateFailed ListRoverEntitlementsLifecycleStateEnum = "FAILED"
)
func GetListRoverEntitlementsLifecycleStateEnumValues() []ListRoverEntitlementsLifecycleStateEnum
GetListRoverEntitlementsLifecycleStateEnumValues Enumerates the set of values for ListRoverEntitlementsLifecycleStateEnum
func GetMappingListRoverEntitlementsLifecycleStateEnum(val string) (ListRoverEntitlementsLifecycleStateEnum, bool)
GetMappingListRoverEntitlementsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverEntitlementsRequest wrapper for the ListRoverEntitlements operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListRoverEntitlements.go.html to see an example of how to use ListRoverEntitlementsRequest.
type ListRoverEntitlementsRequest struct {
// The OCID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// filtering by Rover Device Entitlement id
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState ListRoverEntitlementsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListRoverEntitlementsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
SortBy ListRoverEntitlementsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRoverEntitlementsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRoverEntitlementsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRoverEntitlementsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRoverEntitlementsRequest) String() string
func (request ListRoverEntitlementsRequest) 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
ListRoverEntitlementsResponse wrapper for the ListRoverEntitlements operation
type ListRoverEntitlementsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RoverEntitlementCollection instances
RoverEntitlementCollection `presentIn:"body"`
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the previous batch of items.
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListRoverEntitlementsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRoverEntitlementsResponse) String() string
ListRoverEntitlementsSortByEnum Enum with underlying type: string
type ListRoverEntitlementsSortByEnum string
Set of constants representing the allowable values for ListRoverEntitlementsSortByEnum
const (
ListRoverEntitlementsSortByTimecreated ListRoverEntitlementsSortByEnum = "timeCreated"
ListRoverEntitlementsSortByDisplayname ListRoverEntitlementsSortByEnum = "displayName"
)
func GetListRoverEntitlementsSortByEnumValues() []ListRoverEntitlementsSortByEnum
GetListRoverEntitlementsSortByEnumValues Enumerates the set of values for ListRoverEntitlementsSortByEnum
func GetMappingListRoverEntitlementsSortByEnum(val string) (ListRoverEntitlementsSortByEnum, bool)
GetMappingListRoverEntitlementsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverEntitlementsSortOrderEnum Enum with underlying type: string
type ListRoverEntitlementsSortOrderEnum string
Set of constants representing the allowable values for ListRoverEntitlementsSortOrderEnum
const (
ListRoverEntitlementsSortOrderAsc ListRoverEntitlementsSortOrderEnum = "ASC"
ListRoverEntitlementsSortOrderDesc ListRoverEntitlementsSortOrderEnum = "DESC"
)
func GetListRoverEntitlementsSortOrderEnumValues() []ListRoverEntitlementsSortOrderEnum
GetListRoverEntitlementsSortOrderEnumValues Enumerates the set of values for ListRoverEntitlementsSortOrderEnum
func GetMappingListRoverEntitlementsSortOrderEnum(val string) (ListRoverEntitlementsSortOrderEnum, bool)
GetMappingListRoverEntitlementsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverNodeRoverBundleRequestsRequest wrapper for the ListRoverNodeRoverBundleRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListRoverNodeRoverBundleRequests.go.html to see an example of how to use ListRoverNodeRoverBundleRequestsRequest.
type ListRoverNodeRoverBundleRequestsRequest struct {
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListRoverNodeRoverBundleRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeTaskCreated is descending. If no value is specified timeTaskCreated is default.
SortBy ListRoverNodeRoverBundleRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRoverNodeRoverBundleRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRoverNodeRoverBundleRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRoverNodeRoverBundleRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRoverNodeRoverBundleRequestsRequest) String() string
func (request ListRoverNodeRoverBundleRequestsRequest) 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
ListRoverNodeRoverBundleRequestsResponse wrapper for the ListRoverNodeRoverBundleRequests operation
type ListRoverNodeRoverBundleRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RoverBundleRequestCollection instances
RoverBundleRequestCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListRoverNodeRoverBundleRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRoverNodeRoverBundleRequestsResponse) String() string
ListRoverNodeRoverBundleRequestsSortByEnum Enum with underlying type: string
type ListRoverNodeRoverBundleRequestsSortByEnum string
Set of constants representing the allowable values for ListRoverNodeRoverBundleRequestsSortByEnum
const (
ListRoverNodeRoverBundleRequestsSortByTimetaskcreated ListRoverNodeRoverBundleRequestsSortByEnum = "timeTaskCreated"
)
func GetListRoverNodeRoverBundleRequestsSortByEnumValues() []ListRoverNodeRoverBundleRequestsSortByEnum
GetListRoverNodeRoverBundleRequestsSortByEnumValues Enumerates the set of values for ListRoverNodeRoverBundleRequestsSortByEnum
func GetMappingListRoverNodeRoverBundleRequestsSortByEnum(val string) (ListRoverNodeRoverBundleRequestsSortByEnum, bool)
GetMappingListRoverNodeRoverBundleRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverNodeRoverBundleRequestsSortOrderEnum Enum with underlying type: string
type ListRoverNodeRoverBundleRequestsSortOrderEnum string
Set of constants representing the allowable values for ListRoverNodeRoverBundleRequestsSortOrderEnum
const (
ListRoverNodeRoverBundleRequestsSortOrderAsc ListRoverNodeRoverBundleRequestsSortOrderEnum = "ASC"
ListRoverNodeRoverBundleRequestsSortOrderDesc ListRoverNodeRoverBundleRequestsSortOrderEnum = "DESC"
)
func GetListRoverNodeRoverBundleRequestsSortOrderEnumValues() []ListRoverNodeRoverBundleRequestsSortOrderEnum
GetListRoverNodeRoverBundleRequestsSortOrderEnumValues Enumerates the set of values for ListRoverNodeRoverBundleRequestsSortOrderEnum
func GetMappingListRoverNodeRoverBundleRequestsSortOrderEnum(val string) (ListRoverNodeRoverBundleRequestsSortOrderEnum, bool)
GetMappingListRoverNodeRoverBundleRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverNodesLifecycleStateEnum Enum with underlying type: string
type ListRoverNodesLifecycleStateEnum string
Set of constants representing the allowable values for ListRoverNodesLifecycleStateEnum
const (
ListRoverNodesLifecycleStateCreating ListRoverNodesLifecycleStateEnum = "CREATING"
ListRoverNodesLifecycleStateUpdating ListRoverNodesLifecycleStateEnum = "UPDATING"
ListRoverNodesLifecycleStateActive ListRoverNodesLifecycleStateEnum = "ACTIVE"
ListRoverNodesLifecycleStateDeleting ListRoverNodesLifecycleStateEnum = "DELETING"
ListRoverNodesLifecycleStateDeleted ListRoverNodesLifecycleStateEnum = "DELETED"
ListRoverNodesLifecycleStateFailed ListRoverNodesLifecycleStateEnum = "FAILED"
)
func GetListRoverNodesLifecycleStateEnumValues() []ListRoverNodesLifecycleStateEnum
GetListRoverNodesLifecycleStateEnumValues Enumerates the set of values for ListRoverNodesLifecycleStateEnum
func GetMappingListRoverNodesLifecycleStateEnum(val string) (ListRoverNodesLifecycleStateEnum, bool)
GetMappingListRoverNodesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverNodesNodeTypeEnum Enum with underlying type: string
type ListRoverNodesNodeTypeEnum string
Set of constants representing the allowable values for ListRoverNodesNodeTypeEnum
const (
ListRoverNodesNodeTypeStandalone ListRoverNodesNodeTypeEnum = "STANDALONE"
ListRoverNodesNodeTypeClustered ListRoverNodesNodeTypeEnum = "CLUSTERED"
ListRoverNodesNodeTypeStation ListRoverNodesNodeTypeEnum = "STATION"
)
func GetListRoverNodesNodeTypeEnumValues() []ListRoverNodesNodeTypeEnum
GetListRoverNodesNodeTypeEnumValues Enumerates the set of values for ListRoverNodesNodeTypeEnum
func GetMappingListRoverNodesNodeTypeEnum(val string) (ListRoverNodesNodeTypeEnum, bool)
GetMappingListRoverNodesNodeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverNodesRequest wrapper for the ListRoverNodes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListRoverNodes.go.html to see an example of how to use ListRoverNodesRequest.
type ListRoverNodesRequest struct {
// The OCID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only Nodes of type matched with the given node type.
NodeType ListRoverNodesNodeTypeEnum `mandatory:"false" contributesTo:"query" name:"nodeType" omitEmpty:"true"`
// A filter to return only Nodes of type matched with the given node shape.
Shape *string `mandatory:"false" contributesTo:"query" name:"shape"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState ListRoverNodesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListRoverNodesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
SortBy ListRoverNodesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRoverNodesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRoverNodesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRoverNodesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRoverNodesRequest) String() string
func (request ListRoverNodesRequest) 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
ListRoverNodesResponse wrapper for the ListRoverNodes operation
type ListRoverNodesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RoverNodeCollection instances
RoverNodeCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the previous batch of items.
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListRoverNodesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRoverNodesResponse) String() string
ListRoverNodesSortByEnum Enum with underlying type: string
type ListRoverNodesSortByEnum string
Set of constants representing the allowable values for ListRoverNodesSortByEnum
const (
ListRoverNodesSortByTimecreated ListRoverNodesSortByEnum = "timeCreated"
ListRoverNodesSortByDisplayname ListRoverNodesSortByEnum = "displayName"
)
func GetListRoverNodesSortByEnumValues() []ListRoverNodesSortByEnum
GetListRoverNodesSortByEnumValues Enumerates the set of values for ListRoverNodesSortByEnum
func GetMappingListRoverNodesSortByEnum(val string) (ListRoverNodesSortByEnum, bool)
GetMappingListRoverNodesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRoverNodesSortOrderEnum Enum with underlying type: string
type ListRoverNodesSortOrderEnum string
Set of constants representing the allowable values for ListRoverNodesSortOrderEnum
const (
ListRoverNodesSortOrderAsc ListRoverNodesSortOrderEnum = "ASC"
ListRoverNodesSortOrderDesc ListRoverNodesSortOrderEnum = "DESC"
)
func GetListRoverNodesSortOrderEnumValues() []ListRoverNodesSortOrderEnum
GetListRoverNodesSortOrderEnumValues Enumerates the set of values for ListRoverNodesSortOrderEnum
func GetMappingListRoverNodesSortOrderEnum(val string) (ListRoverNodesSortOrderEnum, bool)
GetMappingListRoverNodesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListShapesRequest wrapper for the ListShapes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListShapes.go.html to see an example of how to use ListShapesRequest.
type ListShapesRequest struct {
// The OCID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListShapesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
SortBy ListShapesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListShapesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListShapesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListShapesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListShapesRequest) String() string
func (request ListShapesRequest) 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
ListShapesResponse wrapper for the ListShapes operation
type ListShapesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ShapeCollection instances
ShapeCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the previous batch of items.
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListShapesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListShapesResponse) String() string
ListShapesSortByEnum Enum with underlying type: string
type ListShapesSortByEnum string
Set of constants representing the allowable values for ListShapesSortByEnum
const (
ListShapesSortByTimecreated ListShapesSortByEnum = "timeCreated"
ListShapesSortByDisplayname ListShapesSortByEnum = "displayName"
)
func GetListShapesSortByEnumValues() []ListShapesSortByEnum
GetListShapesSortByEnumValues Enumerates the set of values for ListShapesSortByEnum
func GetMappingListShapesSortByEnum(val string) (ListShapesSortByEnum, bool)
GetMappingListShapesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListShapesSortOrderEnum Enum with underlying type: string
type ListShapesSortOrderEnum string
Set of constants representing the allowable values for ListShapesSortOrderEnum
const (
ListShapesSortOrderAsc ListShapesSortOrderEnum = "ASC"
ListShapesSortOrderDesc ListShapesSortOrderEnum = "DESC"
)
func GetListShapesSortOrderEnumValues() []ListShapesSortOrderEnum
GetListShapesSortOrderEnumValues Enumerates the set of values for ListShapesSortOrderEnum
func GetMappingListShapesSortOrderEnum(val string) (ListShapesSortOrderEnum, bool)
GetMappingListShapesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ocid of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, the results are shown in descending order. All other fields default to ascending order.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the previous batch of items.
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
ListWorkRequestErrorsSortByMessage ListWorkRequestErrorsSortByEnum = "message"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ocid of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, the results are shown in descending order. All other fields default to ascending order.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogCollection instances
WorkRequestLogCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the previous batch of items.
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
ListWorkRequestLogsSortByMessage ListWorkRequestLogsSortByEnum = "message"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsOperationTypeEnum Enum with underlying type: string
type ListWorkRequestsOperationTypeEnum string
Set of constants representing the allowable values for ListWorkRequestsOperationTypeEnum
const (
ListWorkRequestsOperationTypeAddNodes ListWorkRequestsOperationTypeEnum = "ADD_NODES"
)
func GetListWorkRequestsOperationTypeEnumValues() []ListWorkRequestsOperationTypeEnum
GetListWorkRequestsOperationTypeEnumValues Enumerates the set of values for ListWorkRequestsOperationTypeEnum
func GetMappingListWorkRequestsOperationTypeEnum(val string) (ListWorkRequestsOperationTypeEnum, bool)
GetMappingListWorkRequestsOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// <b>Filter</b> results by the type of the operation associated with the work request.
OperationType ListWorkRequestsOperationTypeEnum `mandatory:"false" contributesTo:"query" name:"operationType" omitEmpty:"true"`
// <b>Filter</b> results by work request status.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// Filter work requests by the resource ocid.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, the results are shown in descending order. All other fields default to ascending order.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestCollection instances
WorkRequestCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the previous batch of items.
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByOperationtype ListWorkRequestsSortByEnum = "operationType"
ListWorkRequestsSortByStatus ListWorkRequestsSortByEnum = "status"
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
NodeTypeEnum Enum with underlying type: string
type NodeTypeEnum string
Set of constants representing the allowable values for NodeTypeEnum
const (
NodeTypeStandalone NodeTypeEnum = "STANDALONE"
NodeTypeClustered NodeTypeEnum = "CLUSTERED"
NodeTypeStation NodeTypeEnum = "STATION"
)
func GetMappingNodeTypeEnum(val string) (NodeTypeEnum, bool)
GetMappingNodeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNodeTypeEnumValues() []NodeTypeEnum
GetNodeTypeEnumValues Enumerates the set of values for NodeTypeEnum
RenewCertificateResponse The information of renewed rover node certificate.
type RenewCertificateResponse struct {
// The id of the rover node.
RoverNodeId *string `mandatory:"true" json:"roverNodeId"`
CertificateDetails *CertificateDetails `mandatory:"false" json:"certificateDetails"`
}
func (m RenewCertificateResponse) String() string
func (m RenewCertificateResponse) 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
ReplaceCaDetails Information about the detailed CA bundle replacement of the rover node.
type ReplaceCaDetails struct {
// Plain text certificate chain in PEM format for the subordinate CA associated with given roverNode.
CaBundlePem *string `mandatory:"false" json:"caBundlePem"`
// Max validity of leaf certificates issued by the CA associated with given node, in days, in ISO 8601 format, example "P365D".
CertificateMaxValidityDuration *string `mandatory:"false" json:"certificateMaxValidityDuration"`
// key algorithm for issuing leaf certificate.
CertKeyAlgorithm CertKeyAlgorithmEnum `mandatory:"false" json:"certKeyAlgorithm,omitempty"`
// signature algorithm for issuing leaf certificate.
CertSignatureAlgorithm CertSignatureAlgorithmEnum `mandatory:"false" json:"certSignatureAlgorithm,omitempty"`
}
func (m ReplaceCaDetails) String() string
func (m ReplaceCaDetails) 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
ReplaceCertificateAuthorityResponse Information about the replace CA Bundle of the rover node.
type ReplaceCertificateAuthorityResponse struct {
// rover node ocid
RoverNodeId *string `mandatory:"true" json:"roverNodeId"`
ReplaceCaDetails *ReplaceCaDetails `mandatory:"false" json:"replaceCaDetails"`
}
func (m ReplaceCertificateAuthorityResponse) String() string
func (m ReplaceCertificateAuthorityResponse) 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
RequestAdditionalNodesDetails Object for request additional nodes for a roverCluster
type RequestAdditionalNodesDetails struct {
// Number of additional nodes to be requested for a roverCluster.
NumberOfAdditionalNodes *int `mandatory:"true" json:"numberOfAdditionalNodes"`
}
func (m RequestAdditionalNodesDetails) String() string
func (m RequestAdditionalNodesDetails) 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
RequestAdditionalNodesRequest wrapper for the RequestAdditionalNodes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RequestAdditionalNodes.go.html to see an example of how to use RequestAdditionalNodesRequest.
type RequestAdditionalNodesRequest struct {
// Unique RoverCluster identifier
RoverClusterId *string `mandatory:"true" contributesTo:"path" name:"roverClusterId"`
// Details object to request additional nodes.
RequestAdditionalNodesDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RequestAdditionalNodesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RequestAdditionalNodesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RequestAdditionalNodesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RequestAdditionalNodesRequest) String() string
func (request RequestAdditionalNodesRequest) 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
RequestAdditionalNodesResponse wrapper for the RequestAdditionalNodes operation
type RequestAdditionalNodesResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a
// particular request, provide this request ID.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response RequestAdditionalNodesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RequestAdditionalNodesResponse) String() string
RequestBundleRoverClusterRequest wrapper for the RequestBundleRoverCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RequestBundleRoverCluster.go.html to see an example of how to use RequestBundleRoverClusterRequest.
type RequestBundleRoverClusterRequest struct {
// Request the rover bundle details.
RequestRoverBundleDetails `contributesTo:"body"`
// Unique RoverCluster identifier
RoverClusterId *string `mandatory:"true" contributesTo:"path" name:"roverClusterId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RequestBundleRoverClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RequestBundleRoverClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RequestBundleRoverClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RequestBundleRoverClusterRequest) String() string
func (request RequestBundleRoverClusterRequest) 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
RequestBundleRoverClusterResponse wrapper for the RequestBundleRoverCluster operation
type RequestBundleRoverClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a
// particular request, provide this request ID.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response RequestBundleRoverClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RequestBundleRoverClusterResponse) String() string
RequestBundleRoverNodeRequest wrapper for the RequestBundleRoverNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RequestBundleRoverNode.go.html to see an example of how to use RequestBundleRoverNodeRequest.
type RequestBundleRoverNodeRequest struct {
// Request the rover bundle details.
RequestRoverBundleDetails `contributesTo:"body"`
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RequestBundleRoverNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RequestBundleRoverNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RequestBundleRoverNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RequestBundleRoverNodeRequest) String() string
func (request RequestBundleRoverNodeRequest) 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
RequestBundleRoverNodeResponse wrapper for the RequestBundleRoverNode operation
type RequestBundleRoverNodeResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a
// particular request, provide this request ID.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response RequestBundleRoverNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RequestBundleRoverNodeResponse) String() string
RequestRoverBundleDetails Information required by Object Storage to process a request to copy an object to another bucket.
type RequestRoverBundleDetails struct {
// The compartment OCID of destination compartment that the bundle will be copied to.
DestinationCompartmentId *string `mandatory:"true" json:"destinationCompartmentId"`
// The destination bucket name the bundle will be copied to.
DestinationBucketName *string `mandatory:"true" json:"destinationBucketName"`
// The bundle version that customer wants to upgrade to.
BundleVersion *string `mandatory:"true" json:"bundleVersion"`
}
func (m RequestRoverBundleDetails) String() string
func (m RequestRoverBundleDetails) 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
RetrieveAvailableBundleVersionsRoverClusterRequest wrapper for the RetrieveAvailableBundleVersionsRoverCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RetrieveAvailableBundleVersionsRoverCluster.go.html to see an example of how to use RetrieveAvailableBundleVersionsRoverClusterRequest.
type RetrieveAvailableBundleVersionsRoverClusterRequest struct {
// Provide the current rover bundle details.
CurrentRoverBundleDetails `contributesTo:"body"`
// Unique RoverCluster identifier
RoverClusterId *string `mandatory:"true" contributesTo:"path" name:"roverClusterId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RetrieveAvailableBundleVersionsRoverClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetrieveAvailableBundleVersionsRoverClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetrieveAvailableBundleVersionsRoverClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetrieveAvailableBundleVersionsRoverClusterRequest) String() string
func (request RetrieveAvailableBundleVersionsRoverClusterRequest) 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
RetrieveAvailableBundleVersionsRoverClusterResponse wrapper for the RetrieveAvailableBundleVersionsRoverCluster operation
type RetrieveAvailableBundleVersionsRoverClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverBundleVersion instance
RoverBundleVersion `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RetrieveAvailableBundleVersionsRoverClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetrieveAvailableBundleVersionsRoverClusterResponse) String() string
RetrieveAvailableBundleVersionsRoverNodeRequest wrapper for the RetrieveAvailableBundleVersionsRoverNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RetrieveAvailableBundleVersionsRoverNode.go.html to see an example of how to use RetrieveAvailableBundleVersionsRoverNodeRequest.
type RetrieveAvailableBundleVersionsRoverNodeRequest struct {
// Provide the current rover bundle details.
CurrentRoverBundleDetails `contributesTo:"body"`
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RetrieveAvailableBundleVersionsRoverNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetrieveAvailableBundleVersionsRoverNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetrieveAvailableBundleVersionsRoverNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetrieveAvailableBundleVersionsRoverNodeRequest) String() string
func (request RetrieveAvailableBundleVersionsRoverNodeRequest) 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
RetrieveAvailableBundleVersionsRoverNodeResponse wrapper for the RetrieveAvailableBundleVersionsRoverNode operation
type RetrieveAvailableBundleVersionsRoverNodeResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverBundleVersion instance
RoverBundleVersion `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RetrieveAvailableBundleVersionsRoverNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetrieveAvailableBundleVersionsRoverNodeResponse) String() string
RetrieveBundleStatusRoverClusterRequest wrapper for the RetrieveBundleStatusRoverCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RetrieveBundleStatusRoverCluster.go.html to see an example of how to use RetrieveBundleStatusRoverClusterRequest.
type RetrieveBundleStatusRoverClusterRequest struct {
// Provide the rover bundle details that requires to retrieve its status.
RoverBundleStatusDetails `contributesTo:"body"`
// Unique RoverCluster identifier
RoverClusterId *string `mandatory:"true" contributesTo:"path" name:"roverClusterId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RetrieveBundleStatusRoverClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetrieveBundleStatusRoverClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetrieveBundleStatusRoverClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetrieveBundleStatusRoverClusterRequest) String() string
func (request RetrieveBundleStatusRoverClusterRequest) 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
RetrieveBundleStatusRoverClusterResponse wrapper for the RetrieveBundleStatusRoverCluster operation
type RetrieveBundleStatusRoverClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverBundleStatus instance
RoverBundleStatus `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RetrieveBundleStatusRoverClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetrieveBundleStatusRoverClusterResponse) String() string
RetrieveBundleStatusRoverNodeRequest wrapper for the RetrieveBundleStatusRoverNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RetrieveBundleStatusRoverNode.go.html to see an example of how to use RetrieveBundleStatusRoverNodeRequest.
type RetrieveBundleStatusRoverNodeRequest struct {
// Provide the rover bundle details that requires to retrieve its status.
RoverBundleStatusDetails `contributesTo:"body"`
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RetrieveBundleStatusRoverNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetrieveBundleStatusRoverNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetrieveBundleStatusRoverNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetrieveBundleStatusRoverNodeRequest) String() string
func (request RetrieveBundleStatusRoverNodeRequest) 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
RetrieveBundleStatusRoverNodeResponse wrapper for the RetrieveBundleStatusRoverNode operation
type RetrieveBundleStatusRoverNodeResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverBundleStatus instance
RoverBundleStatus `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RetrieveBundleStatusRoverNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetrieveBundleStatusRoverNodeResponse) String() string
RoverBundleClient a client for RoverBundle
type RoverBundleClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewRoverBundleClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RoverBundleClient, err error)
NewRoverBundleClientWithConfigurationProvider Creates a new default RoverBundle client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewRoverBundleClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RoverBundleClient, err error)
NewRoverBundleClientWithOboToken Creates a new default RoverBundle client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *RoverBundleClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client RoverBundleClient) ListRoverClusterRoverBundleRequests(ctx context.Context, request ListRoverClusterRoverBundleRequestsRequest) (response ListRoverClusterRoverBundleRequestsResponse, err error)
ListRoverClusterRoverBundleRequests List all the roverBundleRequests for a given roverClusterId.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListRoverClusterRoverBundleRequests.go.html to see an example of how to use ListRoverClusterRoverBundleRequests API. A default retry strategy applies to this operation ListRoverClusterRoverBundleRequests()
func (client RoverBundleClient) ListRoverNodeRoverBundleRequests(ctx context.Context, request ListRoverNodeRoverBundleRequestsRequest) (response ListRoverNodeRoverBundleRequestsResponse, err error)
ListRoverNodeRoverBundleRequests List all the roverBundleRequests for a given roverNodeId.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListRoverNodeRoverBundleRequests.go.html to see an example of how to use ListRoverNodeRoverBundleRequests API. A default retry strategy applies to this operation ListRoverNodeRoverBundleRequests()
func (client RoverBundleClient) RequestBundleRoverCluster(ctx context.Context, request RequestBundleRoverClusterRequest) (response RequestBundleRoverClusterResponse, err error)
RequestBundleRoverCluster Request to get rover bundle to the bucket in customer's tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RequestBundleRoverCluster.go.html to see an example of how to use RequestBundleRoverCluster API. A default retry strategy applies to this operation RequestBundleRoverCluster()
func (client RoverBundleClient) RequestBundleRoverNode(ctx context.Context, request RequestBundleRoverNodeRequest) (response RequestBundleRoverNodeResponse, err error)
RequestBundleRoverNode Request to get rover bundle to the bucket in customer's tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RequestBundleRoverNode.go.html to see an example of how to use RequestBundleRoverNode API. A default retry strategy applies to this operation RequestBundleRoverNode()
func (client RoverBundleClient) RetrieveAvailableBundleVersionsRoverCluster(ctx context.Context, request RetrieveAvailableBundleVersionsRoverClusterRequest) (response RetrieveAvailableBundleVersionsRoverClusterResponse, err error)
RetrieveAvailableBundleVersionsRoverCluster Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RetrieveAvailableBundleVersionsRoverCluster.go.html to see an example of how to use RetrieveAvailableBundleVersionsRoverCluster API. A default retry strategy applies to this operation RetrieveAvailableBundleVersionsRoverCluster()
func (client RoverBundleClient) RetrieveAvailableBundleVersionsRoverNode(ctx context.Context, request RetrieveAvailableBundleVersionsRoverNodeRequest) (response RetrieveAvailableBundleVersionsRoverNodeResponse, err error)
RetrieveAvailableBundleVersionsRoverNode Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RetrieveAvailableBundleVersionsRoverNode.go.html to see an example of how to use RetrieveAvailableBundleVersionsRoverNode API. A default retry strategy applies to this operation RetrieveAvailableBundleVersionsRoverNode()
func (client RoverBundleClient) RetrieveBundleStatusRoverCluster(ctx context.Context, request RetrieveBundleStatusRoverClusterRequest) (response RetrieveBundleStatusRoverClusterResponse, err error)
RetrieveBundleStatusRoverCluster Retrieve the status and progress of a rover bundle copy request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RetrieveBundleStatusRoverCluster.go.html to see an example of how to use RetrieveBundleStatusRoverCluster API. A default retry strategy applies to this operation RetrieveBundleStatusRoverCluster()
func (client RoverBundleClient) RetrieveBundleStatusRoverNode(ctx context.Context, request RetrieveBundleStatusRoverNodeRequest) (response RetrieveBundleStatusRoverNodeResponse, err error)
RetrieveBundleStatusRoverNode Retrieve the status and progress of a rover bundle copy request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RetrieveBundleStatusRoverNode.go.html to see an example of how to use RetrieveBundleStatusRoverNode API. A default retry strategy applies to this operation RetrieveBundleStatusRoverNode()
func (client *RoverBundleClient) SetRegion(region string)
SetRegion overrides the region of this client.
RoverBundleRequestCollection All the roverBundleRequests associated to this roverNode or roverCluster.
type RoverBundleRequestCollection struct {
// List of roverBundleRequests.
Items []RoverBundleRequestSummary `mandatory:"true" json:"items"`
}
func (m RoverBundleRequestCollection) String() string
func (m RoverBundleRequestCollection) 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
RoverBundleRequestSummary Summary of the RoverBundleRequest
type RoverBundleRequestSummary struct {
// The unique identifier of roverBundleRequest.
Id *string `mandatory:"true" json:"id"`
// The work request id for an async copyObject operation.
WorkRequestId *string `mandatory:"true" json:"workRequestId"`
// The OCID of destination compartment that the bundle will be copied to.
DestinationCompartmentId *string `mandatory:"false" json:"destinationCompartmentId"`
// The destination bucket name the bundle will be copied to.
DestinationBucketName *string `mandatory:"false" json:"destinationBucketName"`
// The bundle version that customer wants to upgrade to.
BundleVersion *string `mandatory:"false" json:"bundleVersion"`
// The time of the task was created. An RFC3339 formatted datetime string.
TimeTaskCreated *common.SDKTime `mandatory:"false" json:"timeTaskCreated"`
}
func (m RoverBundleRequestSummary) String() string
func (m RoverBundleRequestSummary) 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
RoverBundleStatus The status of the rover bundle status by a specified work request id.
type RoverBundleStatus struct {
// The progress of the workflow.
Status RoverBundleStatusStatusEnum `mandatory:"true" json:"status"`
// Percentage of the work request completed.
PercentComplete *float32 `mandatory:"false" json:"percentComplete"`
// The date and time the work request was created. An RFC3339 formatted datetime string.
TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`
// The date and time the work request was started. An RFC3339 formatted datetime string.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished. An RFC3339 formatted datetime string.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The full name of the bundle.
BundleName *string `mandatory:"false" json:"bundleName"`
// The error message if work request fails.
ErrorMessage *string `mandatory:"false" json:"errorMessage"`
}
func (m RoverBundleStatus) String() string
func (m RoverBundleStatus) 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
RoverBundleStatusDetails Information required to retrieve rover bundle status of a copyObject operation.
type RoverBundleStatusDetails struct {
// The workRequestId for an async copyObject operation.
WorkRequestId *string `mandatory:"true" json:"workRequestId"`
}
func (m RoverBundleStatusDetails) String() string
func (m RoverBundleStatusDetails) 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
RoverBundleStatusStatusEnum Enum with underlying type: string
type RoverBundleStatusStatusEnum string
Set of constants representing the allowable values for RoverBundleStatusStatusEnum
const (
RoverBundleStatusStatusAccepted RoverBundleStatusStatusEnum = "ACCEPTED"
RoverBundleStatusStatusInProgress RoverBundleStatusStatusEnum = "IN_PROGRESS"
RoverBundleStatusStatusFailed RoverBundleStatusStatusEnum = "FAILED"
RoverBundleStatusStatusCompleted RoverBundleStatusStatusEnum = "COMPLETED"
RoverBundleStatusStatusCanceling RoverBundleStatusStatusEnum = "CANCELING"
RoverBundleStatusStatusCanceled RoverBundleStatusStatusEnum = "CANCELED"
)
func GetMappingRoverBundleStatusStatusEnum(val string) (RoverBundleStatusStatusEnum, bool)
GetMappingRoverBundleStatusStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRoverBundleStatusStatusEnumValues() []RoverBundleStatusStatusEnum
GetRoverBundleStatusStatusEnumValues Enumerates the set of values for RoverBundleStatusStatusEnum
RoverBundleVersion Description of rover bundle version.
type RoverBundleVersion struct {
// The version of the rover bundle.
BundleVersion *string `mandatory:"true" json:"bundleVersion"`
// The compartment OCID of roverNode/roverCluster that needs to be upgraded.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The full name of the bundle.
BundleName *string `mandatory:"false" json:"bundleName"`
}
func (m RoverBundleVersion) String() string
func (m RoverBundleVersion) 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
RoverCluster Description of RoverCluster.
type RoverCluster struct {
// The OCID of RoverCluster.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment containing the RoverCluster.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Size of the cluster.
ClusterSize *int `mandatory:"true" json:"clusterSize"`
// The current state of the RoverCluster.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the the RoverCluster was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// A property that can contain details on the lifecycle.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
CustomerShippingAddress *ShippingAddress `mandatory:"false" json:"customerShippingAddress"`
// The summary of nodes that are part of this cluster.
Nodes []RoverNodeSummary `mandatory:"false" json:"nodes"`
// The type of enclosure rover nodes in this cluster are shipped in.
EnclosureType EnclosureTypeEnum `mandatory:"false" json:"enclosureType,omitempty"`
// Time when customer received the cluster.
TimeCustomerReceived *common.SDKTime `mandatory:"false" json:"timeCustomerReceived"`
// Time when customer returned the cluster.
TimeCustomerReturned *common.SDKTime `mandatory:"false" json:"timeCustomerReturned"`
// Tracking information for device shipping.
DeliveryTrackingInfo *string `mandatory:"false" json:"deliveryTrackingInfo"`
// List of existing workloads that should be provisioned on the nodes.
ClusterWorkloads []RoverWorkload `mandatory:"false" json:"clusterWorkloads"`
// Type of cluster.
ClusterType ClusterTypeEnum `mandatory:"false" json:"clusterType,omitempty"`
// ID provided to customer after successful subscription to Rover Stations.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// Service generated code for the exterior trailer door of the trailer.
ExteriorDoorCode *string `mandatory:"false" json:"exteriorDoorCode"`
// Service generated code to disarm the interior alarm of the trailer.
InteriorAlarmDisarmCode *string `mandatory:"false" json:"interiorAlarmDisarmCode"`
// Root password for the rover cluster.
SuperUserPassword *string `mandatory:"false" json:"superUserPassword"`
// Password to unlock the rover cluster.
UnlockPassphrase *string `mandatory:"false" json:"unlockPassphrase"`
// Name of point of contact for this order if customer is picking up.
PointOfContact *string `mandatory:"false" json:"pointOfContact"`
// Phone number of point of contact for this order if customer is picking up.
PointOfContactPhoneNumber *string `mandatory:"false" json:"pointOfContactPhoneNumber"`
// Preference for device delivery.
ShippingPreference RoverClusterShippingPreferenceEnum `mandatory:"false" json:"shippingPreference,omitempty"`
// Tracking Url for the shipped Rover Cluster.
OracleShippingTrackingUrl *string `mandatory:"false" json:"oracleShippingTrackingUrl"`
// Shipping vendor of choice for orace to customer shipping.
ShippingVendor *string `mandatory:"false" json:"shippingVendor"`
// Expected date when customer wants to pickup the device if they chose customer pickup.
TimePickupExpected *common.SDKTime `mandatory:"false" json:"timePickupExpected"`
// Start time for the window to pickup the device from customer.
TimeReturnWindowStarts *common.SDKTime `mandatory:"false" json:"timeReturnWindowStarts"`
// End time for the window to pickup the device from customer.
TimeReturnWindowEnds *common.SDKTime `mandatory:"false" json:"timeReturnWindowEnds"`
// Uri to download return shipping label.
ReturnShippingLabelUri *string `mandatory:"false" json:"returnShippingLabelUri"`
// The flag indicating that customer requests data to be imported to OCI upon Rover cluster return.
IsImportRequested *bool `mandatory:"false" json:"isImportRequested"`
// An OCID of a compartment where data will be imported to upon Rover cluster return.
ImportCompartmentId *string `mandatory:"false" json:"importCompartmentId"`
// Name of a bucket where files from NFS share will be imported to upon Rover cluster return.
ImportFileBucket *string `mandatory:"false" json:"importFileBucket"`
// Validation code returned by data validation tool. Required for return shipping label generation if data import was requested.
DataValidationCode *string `mandatory:"false" json:"dataValidationCode"`
// The link to pre-authenticated request for a bucket where image workloads are moved.
ImageExportPar *string `mandatory:"false" json:"imageExportPar"`
// Customer provided master key ID to encrypt secret information. If not provided, Rover's master key will be used for encryption.
MasterKeyId *string `mandatory:"false" json:"masterKeyId"`
// The tags associated with tagSlug.
Tags *string `mandatory:"false" json:"tags"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m RoverCluster) String() string
func (m RoverCluster) 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
RoverClusterCertificate The certificate response
type RoverClusterCertificate struct {
// The certificate that can be installed on a client to do TLS communication to the cluster
Certificate *string `mandatory:"true" json:"certificate"`
}
func (m RoverClusterCertificate) String() string
func (m RoverClusterCertificate) 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
RoverClusterClient a client for RoverCluster
type RoverClusterClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewRoverClusterClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RoverClusterClient, err error)
NewRoverClusterClientWithConfigurationProvider Creates a new default RoverCluster client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewRoverClusterClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RoverClusterClient, err error)
NewRoverClusterClientWithOboToken Creates a new default RoverCluster client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client RoverClusterClient) ChangeRoverClusterCompartment(ctx context.Context, request ChangeRoverClusterCompartmentRequest) (response ChangeRoverClusterCompartmentResponse, err error)
ChangeRoverClusterCompartment Moves a cluster into a different compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ChangeRoverClusterCompartment.go.html to see an example of how to use ChangeRoverClusterCompartment API. A default retry strategy applies to this operation ChangeRoverClusterCompartment()
func (client *RoverClusterClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client RoverClusterClient) CreateRoverCluster(ctx context.Context, request CreateRoverClusterRequest) (response CreateRoverClusterResponse, err error)
CreateRoverCluster Creates a new RoverCluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/CreateRoverCluster.go.html to see an example of how to use CreateRoverCluster API. A default retry strategy applies to this operation CreateRoverCluster()
func (client RoverClusterClient) DeleteRoverCluster(ctx context.Context, request DeleteRoverClusterRequest) (response DeleteRoverClusterResponse, err error)
DeleteRoverCluster Deletes a RoverCluster resource by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/DeleteRoverCluster.go.html to see an example of how to use DeleteRoverCluster API. A default retry strategy applies to this operation DeleteRoverCluster()
func (client RoverClusterClient) GetRoverCluster(ctx context.Context, request GetRoverClusterRequest) (response GetRoverClusterResponse, err error)
GetRoverCluster Gets a RoverCluster by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverCluster.go.html to see an example of how to use GetRoverCluster API. A default retry strategy applies to this operation GetRoverCluster()
func (client RoverClusterClient) GetRoverClusterCertificate(ctx context.Context, request GetRoverClusterCertificateRequest) (response GetRoverClusterCertificateResponse, err error)
GetRoverClusterCertificate Get the certificate for a rover cluster
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverClusterCertificate.go.html to see an example of how to use GetRoverClusterCertificate API. A default retry strategy applies to this operation GetRoverClusterCertificate()
func (client RoverClusterClient) ListRoverClusters(ctx context.Context, request ListRoverClustersRequest) (response ListRoverClustersResponse, err error)
ListRoverClusters Returns a list of RoverClusters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListRoverClusters.go.html to see an example of how to use ListRoverClusters API. A default retry strategy applies to this operation ListRoverClusters()
func (client RoverClusterClient) RequestAdditionalNodes(ctx context.Context, request RequestAdditionalNodesRequest) (response RequestAdditionalNodesResponse, err error)
RequestAdditionalNodes Submit additional nodes request for a roverCluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RequestAdditionalNodes.go.html to see an example of how to use RequestAdditionalNodes API. A default retry strategy applies to this operation RequestAdditionalNodes()
func (client *RoverClusterClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client RoverClusterClient) UpdateRoverCluster(ctx context.Context, request UpdateRoverClusterRequest) (response UpdateRoverClusterResponse, err error)
UpdateRoverCluster Updates the RoverCluster
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/UpdateRoverCluster.go.html to see an example of how to use UpdateRoverCluster API. A default retry strategy applies to this operation UpdateRoverCluster()
RoverClusterCollection Results of a roverCluster search. Contains both RoverClusterSummary items and other data.
type RoverClusterCollection struct {
// List of roverClusterSummary.
Items []RoverClusterSummary `mandatory:"true" json:"items"`
}
func (m RoverClusterCollection) String() string
func (m RoverClusterCollection) 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
RoverClusterShippingPreferenceEnum Enum with underlying type: string
type RoverClusterShippingPreferenceEnum string
Set of constants representing the allowable values for RoverClusterShippingPreferenceEnum
const (
RoverClusterShippingPreferenceOracleShipped RoverClusterShippingPreferenceEnum = "ORACLE_SHIPPED"
RoverClusterShippingPreferenceCustomerPickup RoverClusterShippingPreferenceEnum = "CUSTOMER_PICKUP"
)
func GetMappingRoverClusterShippingPreferenceEnum(val string) (RoverClusterShippingPreferenceEnum, bool)
GetMappingRoverClusterShippingPreferenceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRoverClusterShippingPreferenceEnumValues() []RoverClusterShippingPreferenceEnum
GetRoverClusterShippingPreferenceEnumValues Enumerates the set of values for RoverClusterShippingPreferenceEnum
RoverClusterSummary Summary of the RoverCluster.
type RoverClusterSummary struct {
// The OCID of RoverCluster.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment containing the RoverCluster.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The current state of the RoverCluster.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The time the the RoverCluster was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The nodes that are part of this cluster.
Nodes []string `mandatory:"false" json:"nodes"`
// Size of the cluster.
ClusterSize *int `mandatory:"false" json:"clusterSize"`
// Type of cluster.
ClusterType ClusterTypeEnum `mandatory:"false" json:"clusterType,omitempty"`
// A property that can contain details on the lifecycle.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m RoverClusterSummary) String() string
func (m RoverClusterSummary) 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
RoverEntitlement Information about a RoverEntitlement.
type RoverEntitlement struct {
// A property that can uniquely identify the rover entitlement.
Id *string `mandatory:"true" json:"id"`
// The compartment Id for the entitlement.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Requestor name for the entitlement.
RequestorName *string `mandatory:"true" json:"requestorName"`
// Requestor email for the entitlement.
RequestorEmail *string `mandatory:"true" json:"requestorEmail"`
// Lifecyclestate for the entitlement.
LifecycleState RoverEntitlementLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// tenant Id.
TenantId *string `mandatory:"false" json:"tenantId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Details about the entitlement.
EntitlementDetails *string `mandatory:"false" json:"entitlementDetails"`
// A property that can contain details on the lifecycle.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// Time of creation for the entitlement.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Time when the entitlement was last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m RoverEntitlement) String() string
func (m RoverEntitlement) 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
RoverEntitlementClient a client for RoverEntitlement
type RoverEntitlementClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewRoverEntitlementClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RoverEntitlementClient, err error)
NewRoverEntitlementClientWithConfigurationProvider Creates a new default RoverEntitlement client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewRoverEntitlementClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RoverEntitlementClient, err error)
NewRoverEntitlementClientWithOboToken Creates a new default RoverEntitlement client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client RoverEntitlementClient) ChangeRoverEntitlementCompartment(ctx context.Context, request ChangeRoverEntitlementCompartmentRequest) (response ChangeRoverEntitlementCompartmentResponse, err error)
ChangeRoverEntitlementCompartment Moves an entitlement into a different compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ChangeRoverEntitlementCompartment.go.html to see an example of how to use ChangeRoverEntitlementCompartment API. A default retry strategy applies to this operation ChangeRoverEntitlementCompartment()
func (client *RoverEntitlementClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client RoverEntitlementClient) CreateRoverEntitlement(ctx context.Context, request CreateRoverEntitlementRequest) (response CreateRoverEntitlementResponse, err error)
CreateRoverEntitlement Create the Entitlement to use a Rover Device. It requires some offline process of review and signatures before request is granted.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/CreateRoverEntitlement.go.html to see an example of how to use CreateRoverEntitlement API. A default retry strategy applies to this operation CreateRoverEntitlement()
func (client RoverEntitlementClient) DeleteRoverEntitlement(ctx context.Context, request DeleteRoverEntitlementRequest) (response DeleteRoverEntitlementResponse, err error)
DeleteRoverEntitlement Deletes a rover entitlement
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/DeleteRoverEntitlement.go.html to see an example of how to use DeleteRoverEntitlement API. A default retry strategy applies to this operation DeleteRoverEntitlement()
func (client RoverEntitlementClient) GetRoverEntitlement(ctx context.Context, request GetRoverEntitlementRequest) (response GetRoverEntitlementResponse, err error)
GetRoverEntitlement Describes the Rover Device Entitlement in detail
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverEntitlement.go.html to see an example of how to use GetRoverEntitlement API. A default retry strategy applies to this operation GetRoverEntitlement()
func (client RoverEntitlementClient) ListRoverEntitlements(ctx context.Context, request ListRoverEntitlementsRequest) (response ListRoverEntitlementsResponse, err error)
ListRoverEntitlements Returns a list of RoverEntitlements.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListRoverEntitlements.go.html to see an example of how to use ListRoverEntitlements API. A default retry strategy applies to this operation ListRoverEntitlements()
func (client *RoverEntitlementClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client RoverEntitlementClient) UpdateRoverEntitlement(ctx context.Context, request UpdateRoverEntitlementRequest) (response UpdateRoverEntitlementResponse, err error)
UpdateRoverEntitlement Updates the RoverEntitlement
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/UpdateRoverEntitlement.go.html to see an example of how to use UpdateRoverEntitlement API. A default retry strategy applies to this operation UpdateRoverEntitlement()
RoverEntitlementCollection Results of a roverEntitlement search. Contains RoverEntitlementSummary.
type RoverEntitlementCollection struct {
// List of RoverEntitlementSummary.
Items []RoverEntitlementSummary `mandatory:"true" json:"items"`
}
func (m RoverEntitlementCollection) String() string
func (m RoverEntitlementCollection) 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
RoverEntitlementLifecycleStateEnum Enum with underlying type: string
type RoverEntitlementLifecycleStateEnum string
Set of constants representing the allowable values for RoverEntitlementLifecycleStateEnum
const (
RoverEntitlementLifecycleStateCreating RoverEntitlementLifecycleStateEnum = "CREATING"
RoverEntitlementLifecycleStateActive RoverEntitlementLifecycleStateEnum = "ACTIVE"
RoverEntitlementLifecycleStateInactive RoverEntitlementLifecycleStateEnum = "INACTIVE"
RoverEntitlementLifecycleStateDeleted RoverEntitlementLifecycleStateEnum = "DELETED"
)
func GetMappingRoverEntitlementLifecycleStateEnum(val string) (RoverEntitlementLifecycleStateEnum, bool)
GetMappingRoverEntitlementLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRoverEntitlementLifecycleStateEnumValues() []RoverEntitlementLifecycleStateEnum
GetRoverEntitlementLifecycleStateEnumValues Enumerates the set of values for RoverEntitlementLifecycleStateEnum
RoverEntitlementSummary Rover entitlement summary.
type RoverEntitlementSummary struct {
// The compartment Id.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Lifecyclestate for the entitlement.
LifecycleState RoverEntitlementLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Id of the entitlement.
Id *string `mandatory:"false" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Requestor name for the entitlement.
RequestorName *string `mandatory:"false" json:"requestorName"`
// Email id of the requestor for entitlement.
RequestorEmail *string `mandatory:"false" json:"requestorEmail"`
// A property that can contain details on the lifecycle.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m RoverEntitlementSummary) String() string
func (m RoverEntitlementSummary) 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
RoverNode Information about a RoverNode.
type RoverNode struct {
// The OCID of RoverNode.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment containing the RoverNode.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the RoverNode.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The cluster ID if the node is part of a cluster.
ClusterId *string `mandatory:"false" json:"clusterId"`
// The type of node indicating if it belongs to a cluster
NodeType NodeTypeEnum `mandatory:"false" json:"nodeType,omitempty"`
// The shape of the node.
Shape *string `mandatory:"false" json:"shape"`
// The type of enclosure rover node is shipped in.
EnclosureType EnclosureTypeEnum `mandatory:"false" json:"enclosureType,omitempty"`
// Serial number of the node.
SerialNumber *string `mandatory:"false" json:"serialNumber"`
// The time the the RoverNode was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// A property that can contain details on the lifecycle.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
CustomerShippingAddress *ShippingAddress `mandatory:"false" json:"customerShippingAddress"`
// List of existing workloads that should be provisioned on the node.
NodeWorkloads []RoverWorkload `mandatory:"false" json:"nodeWorkloads"`
// Date and time when customer received tne node.
TimeCustomerReceieved *common.SDKTime `mandatory:"false" json:"timeCustomerReceieved"`
// Date and time when customer returned the node.
TimeCustomerReturned *common.SDKTime `mandatory:"false" json:"timeCustomerReturned"`
// Tracking information for device shipping.
DeliveryTrackingInfo *string `mandatory:"false" json:"deliveryTrackingInfo"`
// Root password for the rover node.
SuperUserPassword *string `mandatory:"false" json:"superUserPassword"`
// Password to unlock the rover node.
UnlockPassphrase *string `mandatory:"false" json:"unlockPassphrase"`
// Name of point of contact for this order if customer is picking up.
PointOfContact *string `mandatory:"false" json:"pointOfContact"`
// Phone number of point of contact for this order if customer is picking up.
PointOfContactPhoneNumber *string `mandatory:"false" json:"pointOfContactPhoneNumber"`
// Preference for device delivery.
ShippingPreference RoverNodeShippingPreferenceEnum `mandatory:"false" json:"shippingPreference,omitempty"`
// Shipping vendor of choice for orace to customer shipping.
ShippingVendor *string `mandatory:"false" json:"shippingVendor"`
// Expected date when customer wants to pickup the device if they chose customer pickup.
TimePickupExpected *common.SDKTime `mandatory:"false" json:"timePickupExpected"`
// Start time for the window to pickup the device from customer.
TimeReturnWindowStarts *common.SDKTime `mandatory:"false" json:"timeReturnWindowStarts"`
// Tracking Url for the shipped RoverNode.
OracleShippingTrackingUrl *string `mandatory:"false" json:"oracleShippingTrackingUrl"`
// End time for the window to pickup the device from customer.
TimeReturnWindowEnds *common.SDKTime `mandatory:"false" json:"timeReturnWindowEnds"`
// Uri to download return shipping label.
ReturnShippingLabelUri *string `mandatory:"false" json:"returnShippingLabelUri"`
// The flag indicating that customer requests data to be imported to OCI upon Rover node return.
IsImportRequested *bool `mandatory:"false" json:"isImportRequested"`
// An OCID of a compartment where data will be imported to upon Rover node return.
ImportCompartmentId *string `mandatory:"false" json:"importCompartmentId"`
// Name of a bucket where files from NFS share will be imported to upon Rover node return.
ImportFileBucket *string `mandatory:"false" json:"importFileBucket"`
// Validation code returned by data validation tool. Required for return shipping label generation if data import was requested.
DataValidationCode *string `mandatory:"false" json:"dataValidationCode"`
// The public key of the resource principal
PublicKey *string `mandatory:"false" json:"publicKey"`
// The link to pre-authenticated request for a bucket where image workloads are moved.
ImageExportPar *string `mandatory:"false" json:"imageExportPar"`
// Customer provided master key ID to encrypt secret information. If not provided, Rover's master key will be used for encryption.
MasterKeyId *string `mandatory:"false" json:"masterKeyId"`
// The certificateAuthorityId of subordinate/intermediate certificate authority.
CertificateAuthorityId *string `mandatory:"false" json:"certificateAuthorityId"`
// The time after which leaf certificate will invalid.
TimeCertValidityEnd *common.SDKTime `mandatory:"false" json:"timeCertValidityEnd"`
// The common name for the leaf certificate.
CommonName *string `mandatory:"false" json:"commonName"`
// The compartmentId of the leaf certificate.
CertCompartmentId *string `mandatory:"false" json:"certCompartmentId"`
// The version number of the leaf certificate.
CertificateVersionNumber *string `mandatory:"false" json:"certificateVersionNumber"`
// The id of the leaf certificate.
CertificateId *string `mandatory:"false" json:"certificateId"`
// key algorithm for issuing leaf certificate.
CertKeyAlgorithm CertKeyAlgorithmEnum `mandatory:"false" json:"certKeyAlgorithm,omitempty"`
// signature algorithm for issuing leaf certificate.
CertSignatureAlgorithm CertSignatureAlgorithmEnum `mandatory:"false" json:"certSignatureAlgorithm,omitempty"`
// The tags associated with tagSlug.
Tags *string `mandatory:"false" json:"tags"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m RoverNode) String() string
func (m RoverNode) 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
RoverNodeActionRetrieveCaBundleRequest wrapper for the RoverNodeActionRetrieveCaBundle operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RoverNodeActionRetrieveCaBundle.go.html to see an example of how to use RoverNodeActionRetrieveCaBundleRequest.
type RoverNodeActionRetrieveCaBundleRequest struct {
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RoverNodeActionRetrieveCaBundleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RoverNodeActionRetrieveCaBundleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RoverNodeActionRetrieveCaBundleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RoverNodeActionRetrieveCaBundleRequest) String() string
func (request RoverNodeActionRetrieveCaBundleRequest) 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
RoverNodeActionRetrieveCaBundleResponse wrapper for the RoverNodeActionRetrieveCaBundle operation
type RoverNodeActionRetrieveCaBundleResponse struct {
// The underlying http response
RawResponse *http.Response
// The CaBundleResponse instance
CaBundleResponse `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RoverNodeActionRetrieveCaBundleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RoverNodeActionRetrieveCaBundleResponse) String() string
RoverNodeActionSetKeyDetails The information required to update a rover node's set key details.
type RoverNodeActionSetKeyDetails struct {
// The public key of the resource principal
PublicKey *string `mandatory:"false" json:"publicKey"`
}
func (m RoverNodeActionSetKeyDetails) String() string
func (m RoverNodeActionSetKeyDetails) 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
RoverNodeActionSetKeyRequest wrapper for the RoverNodeActionSetKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RoverNodeActionSetKey.go.html to see an example of how to use RoverNodeActionSetKeyRequest.
type RoverNodeActionSetKeyRequest struct {
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The Java Web Token which is a signature of the request that is signed with the resource's private key
// This is meant solely in the context of getRpt
Jwt *string `mandatory:"true" contributesTo:"header" name:"jwt"`
// The information to be updated.
RoverNodeActionSetKeyDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RoverNodeActionSetKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RoverNodeActionSetKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RoverNodeActionSetKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RoverNodeActionSetKeyRequest) String() string
func (request RoverNodeActionSetKeyRequest) 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
RoverNodeActionSetKeyResponse wrapper for the RoverNodeActionSetKey operation
type RoverNodeActionSetKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverNodeSetKey instance
RoverNodeSetKey `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RoverNodeActionSetKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RoverNodeActionSetKeyResponse) String() string
RoverNodeCertificate The certificate response
type RoverNodeCertificate struct {
// The certificate that can be installed on a client to do TLS communication to the node
Certificate *string `mandatory:"true" json:"certificate"`
}
func (m RoverNodeCertificate) String() string
func (m RoverNodeCertificate) 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
RoverNodeClient a client for RoverNode
type RoverNodeClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewRoverNodeClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RoverNodeClient, err error)
NewRoverNodeClientWithConfigurationProvider Creates a new default RoverNode client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewRoverNodeClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RoverNodeClient, err error)
NewRoverNodeClientWithOboToken Creates a new default RoverNode client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client RoverNodeClient) ChangeRoverNodeCompartment(ctx context.Context, request ChangeRoverNodeCompartmentRequest) (response ChangeRoverNodeCompartmentResponse, err error)
ChangeRoverNodeCompartment Moves a rover node into a different compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ChangeRoverNodeCompartment.go.html to see an example of how to use ChangeRoverNodeCompartment API. A default retry strategy applies to this operation ChangeRoverNodeCompartment()
func (client *RoverNodeClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client RoverNodeClient) CreateRoverNode(ctx context.Context, request CreateRoverNodeRequest) (response CreateRoverNodeResponse, err error)
CreateRoverNode Creates a new RoverNode.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/CreateRoverNode.go.html to see an example of how to use CreateRoverNode API. A default retry strategy applies to this operation CreateRoverNode()
func (client RoverNodeClient) DeleteRoverNode(ctx context.Context, request DeleteRoverNodeRequest) (response DeleteRoverNodeResponse, err error)
DeleteRoverNode Deletes a RoverNode resource by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/DeleteRoverNode.go.html to see an example of how to use DeleteRoverNode API. A default retry strategy applies to this operation DeleteRoverNode()
func (client RoverNodeClient) GetRoverNode(ctx context.Context, request GetRoverNodeRequest) (response GetRoverNodeResponse, err error)
GetRoverNode Gets a RoverNode by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverNode.go.html to see an example of how to use GetRoverNode API. A default retry strategy applies to this operation GetRoverNode()
func (client RoverNodeClient) GetRoverNodeCertificate(ctx context.Context, request GetRoverNodeCertificateRequest) (response GetRoverNodeCertificateResponse, err error)
GetRoverNodeCertificate Get the certificate for a rover node
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverNodeCertificate.go.html to see an example of how to use GetRoverNodeCertificate API. A default retry strategy applies to this operation GetRoverNodeCertificate()
func (client RoverNodeClient) GetRoverNodeEncryptionKey(ctx context.Context, request GetRoverNodeEncryptionKeyRequest) (response GetRoverNodeEncryptionKeyResponse, err error)
GetRoverNodeEncryptionKey Get the data encryption key for a rover node.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverNodeEncryptionKey.go.html to see an example of how to use GetRoverNodeEncryptionKey API. A default retry strategy applies to this operation GetRoverNodeEncryptionKey()
func (client RoverNodeClient) GetRoverNodeGetRpt(ctx context.Context, request GetRoverNodeGetRptRequest) (response GetRoverNodeGetRptResponse, err error)
GetRoverNodeGetRpt Get the resource principal token for a rover node
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetRoverNodeGetRpt.go.html to see an example of how to use GetRoverNodeGetRpt API. A default retry strategy applies to this operation GetRoverNodeGetRpt()
func (client RoverNodeClient) ListRoverNodes(ctx context.Context, request ListRoverNodesRequest) (response ListRoverNodesResponse, err error)
ListRoverNodes Returns a list of RoverNodes.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListRoverNodes.go.html to see an example of how to use ListRoverNodes API. A default retry strategy applies to this operation ListRoverNodes()
func (client RoverNodeClient) RoverNodeActionRetrieveCaBundle(ctx context.Context, request RoverNodeActionRetrieveCaBundleRequest) (response RoverNodeActionRetrieveCaBundleResponse, err error)
RoverNodeActionRetrieveCaBundle Retrieve Ca Bundle for a rover node
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RoverNodeActionRetrieveCaBundle.go.html to see an example of how to use RoverNodeActionRetrieveCaBundle API. A default retry strategy applies to this operation RoverNodeActionRetrieveCaBundle()
func (client RoverNodeClient) RoverNodeActionSetKey(ctx context.Context, request RoverNodeActionSetKeyRequest) (response RoverNodeActionSetKeyResponse, err error)
RoverNodeActionSetKey Get the resource principal public key for a rover node
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RoverNodeActionSetKey.go.html to see an example of how to use RoverNodeActionSetKey API. A default retry strategy applies to this operation RoverNodeActionSetKey()
func (client RoverNodeClient) RoverNodeGenerateCertificate(ctx context.Context, request RoverNodeGenerateCertificateRequest) (response RoverNodeGenerateCertificateResponse, err error)
RoverNodeGenerateCertificate Request to generate certificate for a roverNode.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RoverNodeGenerateCertificate.go.html to see an example of how to use RoverNodeGenerateCertificate API. A default retry strategy applies to this operation RoverNodeGenerateCertificate()
func (client RoverNodeClient) RoverNodeRenewCertificate(ctx context.Context, request RoverNodeRenewCertificateRequest) (response RoverNodeRenewCertificateResponse, err error)
RoverNodeRenewCertificate Request to renew certificate for a roverNode.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RoverNodeRenewCertificate.go.html to see an example of how to use RoverNodeRenewCertificate API. A default retry strategy applies to this operation RoverNodeRenewCertificate()
func (client RoverNodeClient) RoverNodeReplaceCertificateAuthority(ctx context.Context, request RoverNodeReplaceCertificateAuthorityRequest) (response RoverNodeReplaceCertificateAuthorityResponse, err error)
RoverNodeReplaceCertificateAuthority Request to replace certificate authority for a roverNode.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RoverNodeReplaceCertificateAuthority.go.html to see an example of how to use RoverNodeReplaceCertificateAuthority API. A default retry strategy applies to this operation RoverNodeReplaceCertificateAuthority()
func (client RoverNodeClient) RoverNodeRetrieveLeafCertificate(ctx context.Context, request RoverNodeRetrieveLeafCertificateRequest) (response RoverNodeRetrieveLeafCertificateResponse, err error)
RoverNodeRetrieveLeafCertificate Retrieve the leaf certificate info for a rover node
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RoverNodeRetrieveLeafCertificate.go.html to see an example of how to use RoverNodeRetrieveLeafCertificate API. A default retry strategy applies to this operation RoverNodeRetrieveLeafCertificate()
func (client *RoverNodeClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client RoverNodeClient) UpdateRoverNode(ctx context.Context, request UpdateRoverNodeRequest) (response UpdateRoverNodeResponse, err error)
UpdateRoverNode Updates the RoverNode
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/UpdateRoverNode.go.html to see an example of how to use UpdateRoverNode API. A default retry strategy applies to this operation UpdateRoverNode()
RoverNodeCollection Results of a roverNode search. Contains both RoverNodeSummary items and other data.
type RoverNodeCollection struct {
// List of roverNodes.
Items []RoverNodeSummary `mandatory:"true" json:"items"`
}
func (m RoverNodeCollection) String() string
func (m RoverNodeCollection) 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
RoverNodeEncryptionKey The response containing encryption key for a rover node.
type RoverNodeEncryptionKey struct {
// The encryption key key for a rover node.
EncryptionKey *string `mandatory:"true" json:"encryptionKey"`
}
func (m RoverNodeEncryptionKey) String() string
func (m RoverNodeEncryptionKey) 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
RoverNodeGenerateCertificateDetails The information required to generate a certificate for a roverNode.
type RoverNodeGenerateCertificateDetails struct {
// The certificate signing request (in PEM format), max size 10240.
Csr *string `mandatory:"true" json:"csr"`
// Time when the generated certificate's validity will end.
TimeCertValidityEnd *common.SDKTime `mandatory:"true" json:"timeCertValidityEnd"`
}
func (m RoverNodeGenerateCertificateDetails) String() string
func (m RoverNodeGenerateCertificateDetails) 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
RoverNodeGenerateCertificateRequest wrapper for the RoverNodeGenerateCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RoverNodeGenerateCertificate.go.html to see an example of how to use RoverNodeGenerateCertificateRequest.
type RoverNodeGenerateCertificateRequest struct {
// The information provided to generate certificate.
RoverNodeGenerateCertificateDetails `contributesTo:"body"`
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RoverNodeGenerateCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RoverNodeGenerateCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RoverNodeGenerateCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RoverNodeGenerateCertificateRequest) String() string
func (request RoverNodeGenerateCertificateRequest) 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
RoverNodeGenerateCertificateResponse wrapper for the RoverNodeGenerateCertificate operation
type RoverNodeGenerateCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The GenerateCertificateResponse instance
GenerateCertificateResponse `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RoverNodeGenerateCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RoverNodeGenerateCertificateResponse) String() string
RoverNodeGetRpt The resource principal token response.
type RoverNodeGetRpt struct {
// The resource principal token blob that contains claims about the resource.
ResourcePrincipalToken *string `mandatory:"true" json:"resourcePrincipalToken"`
// The service principal session token
ServicePrincipalSessionToken *string `mandatory:"false" json:"servicePrincipalSessionToken"`
}
func (m RoverNodeGetRpt) String() string
func (m RoverNodeGetRpt) 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
RoverNodeRenewCertificateDetails The information required to renew a certificate for a roverNode.
type RoverNodeRenewCertificateDetails struct {
// The certificate signing request (in PEM format), max size 10240.
Csr *string `mandatory:"true" json:"csr"`
// Time when the renewed certificate's validity will end.
TimeCertValidityEnd *common.SDKTime `mandatory:"true" json:"timeCertValidityEnd"`
}
func (m RoverNodeRenewCertificateDetails) String() string
func (m RoverNodeRenewCertificateDetails) 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
RoverNodeRenewCertificateRequest wrapper for the RoverNodeRenewCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RoverNodeRenewCertificate.go.html to see an example of how to use RoverNodeRenewCertificateRequest.
type RoverNodeRenewCertificateRequest struct {
// The information provided to renew certificate.
RoverNodeRenewCertificateDetails `contributesTo:"body"`
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RoverNodeRenewCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RoverNodeRenewCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RoverNodeRenewCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RoverNodeRenewCertificateRequest) String() string
func (request RoverNodeRenewCertificateRequest) 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
RoverNodeRenewCertificateResponse wrapper for the RoverNodeRenewCertificate operation
type RoverNodeRenewCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The RenewCertificateResponse instance
RenewCertificateResponse `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RoverNodeRenewCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RoverNodeRenewCertificateResponse) String() string
RoverNodeReplaceCertificateAuthorityDetails The information required to replace a certificate authority details for a roverNode.
type RoverNodeReplaceCertificateAuthorityDetails struct {
// The certificate authority id.
CertificateAuthorityId *string `mandatory:"true" json:"certificateAuthorityId"`
// key algorithm for issuing leaf certificate.
CertKeyAlgorithm CertKeyAlgorithmEnum `mandatory:"false" json:"certKeyAlgorithm,omitempty"`
// signature algorithm for issuing leaf certificate.
CertSignatureAlgorithm CertSignatureAlgorithmEnum `mandatory:"false" json:"certSignatureAlgorithm,omitempty"`
}
func (m RoverNodeReplaceCertificateAuthorityDetails) String() string
func (m RoverNodeReplaceCertificateAuthorityDetails) 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
RoverNodeReplaceCertificateAuthorityRequest wrapper for the RoverNodeReplaceCertificateAuthority operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RoverNodeReplaceCertificateAuthority.go.html to see an example of how to use RoverNodeReplaceCertificateAuthorityRequest.
type RoverNodeReplaceCertificateAuthorityRequest struct {
// The information provided to replace certificate authority.
RoverNodeReplaceCertificateAuthorityDetails `contributesTo:"body"`
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RoverNodeReplaceCertificateAuthorityRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RoverNodeReplaceCertificateAuthorityRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RoverNodeReplaceCertificateAuthorityRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RoverNodeReplaceCertificateAuthorityRequest) String() string
func (request RoverNodeReplaceCertificateAuthorityRequest) 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
RoverNodeReplaceCertificateAuthorityResponse wrapper for the RoverNodeReplaceCertificateAuthority operation
type RoverNodeReplaceCertificateAuthorityResponse struct {
// The underlying http response
RawResponse *http.Response
// The ReplaceCertificateAuthorityResponse instance
ReplaceCertificateAuthorityResponse `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RoverNodeReplaceCertificateAuthorityResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RoverNodeReplaceCertificateAuthorityResponse) String() string
RoverNodeRetrieveLeafCertificateRequest wrapper for the RoverNodeRetrieveLeafCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/RoverNodeRetrieveLeafCertificate.go.html to see an example of how to use RoverNodeRetrieveLeafCertificateRequest.
type RoverNodeRetrieveLeafCertificateRequest struct {
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RoverNodeRetrieveLeafCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RoverNodeRetrieveLeafCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RoverNodeRetrieveLeafCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RoverNodeRetrieveLeafCertificateRequest) String() string
func (request RoverNodeRetrieveLeafCertificateRequest) 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
RoverNodeRetrieveLeafCertificateResponse wrapper for the RoverNodeRetrieveLeafCertificate operation
type RoverNodeRetrieveLeafCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The LeafCertificateResponse instance
LeafCertificateResponse `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RoverNodeRetrieveLeafCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RoverNodeRetrieveLeafCertificateResponse) String() string
RoverNodeSetKey Information about the success of setting a rover node's resource principal public key.
type RoverNodeSetKey struct {
// Whether the node's resource principal public key was set correctly
IsSuccessful *bool `mandatory:"true" json:"isSuccessful"`
}
func (m RoverNodeSetKey) String() string
func (m RoverNodeSetKey) 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
RoverNodeShippingPreferenceEnum Enum with underlying type: string
type RoverNodeShippingPreferenceEnum string
Set of constants representing the allowable values for RoverNodeShippingPreferenceEnum
const (
RoverNodeShippingPreferenceOracleShipped RoverNodeShippingPreferenceEnum = "ORACLE_SHIPPED"
RoverNodeShippingPreferenceCustomerPickup RoverNodeShippingPreferenceEnum = "CUSTOMER_PICKUP"
)
func GetMappingRoverNodeShippingPreferenceEnum(val string) (RoverNodeShippingPreferenceEnum, bool)
GetMappingRoverNodeShippingPreferenceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRoverNodeShippingPreferenceEnumValues() []RoverNodeShippingPreferenceEnum
GetRoverNodeShippingPreferenceEnumValues Enumerates the set of values for RoverNodeShippingPreferenceEnum
RoverNodeSummary Summary of the RoverNode.
type RoverNodeSummary struct {
// The OCID of the RoverNode.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment containing the RoverNode.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The current state of the RoverNode.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The cluster ID if the node is part of a cluster.
ClusterId *string `mandatory:"false" json:"clusterId"`
// Serial number of the node.
SerialNumber *string `mandatory:"false" json:"serialNumber"`
// The type of node indicating if it belongs to a cluster
NodeType NodeTypeEnum `mandatory:"false" json:"nodeType,omitempty"`
// The shape of the node.
Shape *string `mandatory:"false" json:"shape"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The time the the RoverNode was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// A property that can contain details on the lifecycle.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m RoverNodeSummary) String() string
func (m RoverNodeSummary) 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
RoverWorkload Information about a RoverWorkload.
type RoverWorkload struct {
// The OCID of the compartment containing the workload.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The Unique Oracle ID (OCID) that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// The type of workload
WorkloadType *string `mandatory:"true" json:"workloadType"`
// Name of the Rover Workload
Name *string `mandatory:"false" json:"name"`
// Size of the workload.
Size *string `mandatory:"false" json:"size"`
// Number of objects in a workload.
ObjectCount *string `mandatory:"false" json:"objectCount"`
// Prefix to filter objects in case it is a bucket.
Prefix *string `mandatory:"false" json:"prefix"`
// Start of the range in a bucket.
RangeStart *string `mandatory:"false" json:"rangeStart"`
// End of the range in a bucket.
RangeEnd *string `mandatory:"false" json:"rangeEnd"`
// The compute work request id to track progress of custom image exports.
WorkRequestId *string `mandatory:"false" json:"workRequestId"`
}
func (m RoverWorkload) String() string
func (m RoverWorkload) 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
ShapeClient a client for Shape
type ShapeClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewShapeClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ShapeClient, err error)
NewShapeClientWithConfigurationProvider Creates a new default Shape client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewShapeClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ShapeClient, err error)
NewShapeClientWithOboToken Creates a new default Shape client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *ShapeClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ShapeClient) ListShapes(ctx context.Context, request ListShapesRequest) (response ListShapesResponse, err error)
ListShapes Returns a list of Shapes.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListShapes.go.html to see an example of how to use ListShapes API. A default retry strategy applies to this operation ListShapes()
func (client *ShapeClient) SetRegion(region string)
SetRegion overrides the region of this client.
ShapeCollection Results of a listShape search. Contains both Shape items and other data.
type ShapeCollection struct {
// List of shapeSummary objects.
Items []ShapeSummary `mandatory:"true" json:"items"`
}
func (m ShapeCollection) String() string
func (m ShapeCollection) 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
ShapeSummary A shape of a node on a Rover device.
type ShapeSummary struct {
// The name of the shape.
Shape *string `mandatory:"true" json:"shape"`
// A short description of the graphics processing unit (GPU) available for this shape.
GpuDescription *string `mandatory:"false" json:"gpuDescription"`
// The number of GPUs available for this shape.
Gpus *int `mandatory:"false" json:"gpus"`
// The default amount of memory available for this shape, in gigabytes.
MemoryInGBs *float32 `mandatory:"false" json:"memoryInGBs"`
// The networking bandwidth available for this shape, in gigabits per second.
NetworkingBandwidthInGbps *float32 `mandatory:"false" json:"networkingBandwidthInGbps"`
// The default number of OCPUs available for this shape.
Ocpus *int `mandatory:"false" json:"ocpus"`
// A short description of the shape's processor (CPU).
ProcessorDescription *string `mandatory:"false" json:"processorDescription"`
// A short description of the USB controller available for this shape.
UsbControllerDescription *string `mandatory:"false" json:"usbControllerDescription"`
// The number of USB controllers available for this shape.
NumberOfUsbControllers *int `mandatory:"false" json:"numberOfUsbControllers"`
// The tags associated with tagSlug.
Tags *string `mandatory:"false" json:"tags"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ShapeSummary) String() string
func (m ShapeSummary) 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
ShippingAddress Shipping address for rover devices.
type ShippingAddress struct {
// Addressee in shipping address.
Addressee *string `mandatory:"true" json:"addressee"`
// Address line 1.
Address1 *string `mandatory:"true" json:"address1"`
// city or locality for shipping address.
CityOrLocality *string `mandatory:"true" json:"cityOrLocality"`
// state or region for shipping address.
StateOrRegion *string `mandatory:"true" json:"stateOrRegion"`
// zipcode for shipping address.
Zipcode *string `mandatory:"true" json:"zipcode"`
// country for shipping address.
Country *string `mandatory:"true" json:"country"`
// recipient phone number.
PhoneNumber *string `mandatory:"true" json:"phoneNumber"`
// CareOf for shipping address.
CareOf *string `mandatory:"false" json:"careOf"`
// Address line 2.
Address2 *string `mandatory:"false" json:"address2"`
// Address line 3.
Address3 *string `mandatory:"false" json:"address3"`
// Address line 4.
Address4 *string `mandatory:"false" json:"address4"`
// recipient email address.
Email *string `mandatory:"false" json:"email"`
}
func (m ShippingAddress) String() string
func (m ShippingAddress) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SortOrdersEnum Enum with underlying type: string
type SortOrdersEnum string
Set of constants representing the allowable values for SortOrdersEnum
const (
SortOrdersAsc SortOrdersEnum = "ASC"
SortOrdersDesc SortOrdersEnum = "DESC"
)
func GetMappingSortOrdersEnum(val string) (SortOrdersEnum, bool)
GetMappingSortOrdersEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrdersEnumValues() []SortOrdersEnum
GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum
UpdateRoverClusterDetails The information required to update a RoverCluster.
type UpdateRoverClusterDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Number of nodes desired in the cluster, in standalone clusters, between 5 and 15 inclusive. In station clusters, between 15 and 30 inclusive.
ClusterSize *int `mandatory:"false" json:"clusterSize"`
CustomerShippingAddress *ShippingAddress `mandatory:"false" json:"customerShippingAddress"`
// List of existing workloads that should be provisioned on the nodes.
ClusterWorkloads []RoverWorkload `mandatory:"false" json:"clusterWorkloads"`
// Root password for the rover cluster.
SuperUserPassword *string `mandatory:"false" json:"superUserPassword"`
// The current state of the RoverCluster.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A property that can contain details on the lifecycle.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// Password to unlock the rover cluster.
UnlockPassphrase *string `mandatory:"false" json:"unlockPassphrase"`
// The type of enclosure rover nodes in this cluster are shipped in.
EnclosureType EnclosureTypeEnum `mandatory:"false" json:"enclosureType,omitempty"`
// Name of point of contact for this order if customer is picking up.
PointOfContact *string `mandatory:"false" json:"pointOfContact"`
// Phone number of point of contact for this order if customer is picking up.
PointOfContactPhoneNumber *string `mandatory:"false" json:"pointOfContactPhoneNumber"`
// Preference for device delivery.
ShippingPreference UpdateRoverClusterDetailsShippingPreferenceEnum `mandatory:"false" json:"shippingPreference,omitempty"`
// Tracking Url for the shipped Rover Cluster.
OracleShippingTrackingUrl *string `mandatory:"false" json:"oracleShippingTrackingUrl"`
// ID provided to customer after successful subscription to Rover Stations.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// Shipping vendor of choice for orace to customer shipping.
ShippingVendor *string `mandatory:"false" json:"shippingVendor"`
// Expected date when customer wants to pickup the device if they chose customer pickup.
TimePickupExpected *common.SDKTime `mandatory:"false" json:"timePickupExpected"`
// The flag indicating that customer requests data to be imported to OCI upon Rover cluster return.
IsImportRequested *bool `mandatory:"false" json:"isImportRequested"`
// An OCID of a compartment where data will be imported to upon Rover cluster return.
ImportCompartmentId *string `mandatory:"false" json:"importCompartmentId"`
// Name of a bucket where files from NFS share will be imported to upon Rover cluster return.
ImportFileBucket *string `mandatory:"false" json:"importFileBucket"`
// Validation code returned by data validation tool. Required for return shipping label generation if data import was requested.
DataValidationCode *string `mandatory:"false" json:"dataValidationCode"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m UpdateRoverClusterDetails) String() string
func (m UpdateRoverClusterDetails) 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
UpdateRoverClusterDetailsShippingPreferenceEnum Enum with underlying type: string
type UpdateRoverClusterDetailsShippingPreferenceEnum string
Set of constants representing the allowable values for UpdateRoverClusterDetailsShippingPreferenceEnum
const (
UpdateRoverClusterDetailsShippingPreferenceOracleShipped UpdateRoverClusterDetailsShippingPreferenceEnum = "ORACLE_SHIPPED"
UpdateRoverClusterDetailsShippingPreferenceCustomerPickup UpdateRoverClusterDetailsShippingPreferenceEnum = "CUSTOMER_PICKUP"
)
func GetMappingUpdateRoverClusterDetailsShippingPreferenceEnum(val string) (UpdateRoverClusterDetailsShippingPreferenceEnum, bool)
GetMappingUpdateRoverClusterDetailsShippingPreferenceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateRoverClusterDetailsShippingPreferenceEnumValues() []UpdateRoverClusterDetailsShippingPreferenceEnum
GetUpdateRoverClusterDetailsShippingPreferenceEnumValues Enumerates the set of values for UpdateRoverClusterDetailsShippingPreferenceEnum
UpdateRoverClusterRequest wrapper for the UpdateRoverCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/UpdateRoverCluster.go.html to see an example of how to use UpdateRoverClusterRequest.
type UpdateRoverClusterRequest struct {
// Unique RoverCluster identifier
RoverClusterId *string `mandatory:"true" contributesTo:"path" name:"roverClusterId"`
// The information to be updated.
UpdateRoverClusterDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateRoverClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRoverClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRoverClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRoverClusterRequest) String() string
func (request UpdateRoverClusterRequest) 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
UpdateRoverClusterResponse wrapper for the UpdateRoverCluster operation
type UpdateRoverClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverCluster instance
RoverCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateRoverClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRoverClusterResponse) String() string
UpdateRoverEntitlementDetails Information required to update a RoverEntitlement.
type UpdateRoverEntitlementDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// tenant Id.
TenantId *string `mandatory:"false" json:"tenantId"`
// Requestor name for the entitlement.
RequestorName *string `mandatory:"false" json:"requestorName"`
// Requestor email for the entitlement.
RequestorEmail *string `mandatory:"false" json:"requestorEmail"`
// Details about the entitlement.
EntitlementDetails *string `mandatory:"false" json:"entitlementDetails"`
// The current state of the RoverNode.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A property that can contain details on the lifecycle.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m UpdateRoverEntitlementDetails) String() string
func (m UpdateRoverEntitlementDetails) 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
UpdateRoverEntitlementRequest wrapper for the UpdateRoverEntitlement operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/UpdateRoverEntitlement.go.html to see an example of how to use UpdateRoverEntitlementRequest.
type UpdateRoverEntitlementRequest struct {
// ID of the rover node or cluster entitlement
RoverEntitlementId *string `mandatory:"true" contributesTo:"path" name:"roverEntitlementId"`
// The information to be updated.
UpdateRoverEntitlementDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateRoverEntitlementRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRoverEntitlementRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRoverEntitlementRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRoverEntitlementRequest) String() string
func (request UpdateRoverEntitlementRequest) 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
UpdateRoverEntitlementResponse wrapper for the UpdateRoverEntitlement operation
type UpdateRoverEntitlementResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverEntitlement instance
RoverEntitlement `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateRoverEntitlementResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRoverEntitlementResponse) String() string
UpdateRoverNodeDetails The information required to update a RoverNode.
type UpdateRoverNodeDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The shape of workloads in the node.
Shape *string `mandatory:"false" json:"shape"`
// Serial number of the node.
SerialNumber *string `mandatory:"false" json:"serialNumber"`
CustomerShippingAddress *ShippingAddress `mandatory:"false" json:"customerShippingAddress"`
// List of existing workloads that should be provisioned on the node.
NodeWorkloads []RoverWorkload `mandatory:"false" json:"nodeWorkloads"`
// Root password for the rover node.
SuperUserPassword *string `mandatory:"false" json:"superUserPassword"`
// Password to unlock the rover node.
UnlockPassphrase *string `mandatory:"false" json:"unlockPassphrase"`
// Name of point of contact for this order if customer is picking up.
PointOfContact *string `mandatory:"false" json:"pointOfContact"`
// Phone number of point of contact for this order if customer is picking up.
PointOfContactPhoneNumber *string `mandatory:"false" json:"pointOfContactPhoneNumber"`
// Tracking Url for the shipped FmsRoverNode.
OracleShippingTrackingUrl *string `mandatory:"false" json:"oracleShippingTrackingUrl"`
// Preference for device delivery.
ShippingPreference UpdateRoverNodeDetailsShippingPreferenceEnum `mandatory:"false" json:"shippingPreference,omitempty"`
// Shipping vendor of choice for orace to customer shipping.
ShippingVendor *string `mandatory:"false" json:"shippingVendor"`
// Expected date when customer wants to pickup the device if they chose customer pickup.
TimePickupExpected *common.SDKTime `mandatory:"false" json:"timePickupExpected"`
// The current state of the RoverNode.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The type of enclosure rover nodes in this cluster are shipped in.
EnclosureType EnclosureTypeEnum `mandatory:"false" json:"enclosureType,omitempty"`
// A property that can contain details on the lifecycle.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// Start time for the window to pickup the device from customer.
TimeReturnWindowStarts *common.SDKTime `mandatory:"false" json:"timeReturnWindowStarts"`
// End time for the window to pickup the device from customer.
TimeReturnWindowEnds *common.SDKTime `mandatory:"false" json:"timeReturnWindowEnds"`
// The flag indicating that customer requests data to be imported to OCI upon Rover node return.
IsImportRequested *bool `mandatory:"false" json:"isImportRequested"`
// An OCID of a compartment where data will be imported to upon Rover node return.
ImportCompartmentId *string `mandatory:"false" json:"importCompartmentId"`
// Name of a bucket where files from NFS share will be imported to upon Rover node return.
ImportFileBucket *string `mandatory:"false" json:"importFileBucket"`
// Validation code returned by data validation tool. Required for return shipping label generation if data import was requested.
DataValidationCode *string `mandatory:"false" json:"dataValidationCode"`
// The public key of the resource principal
PublicKey *string `mandatory:"false" json:"publicKey"`
// The certificateAuthorityId of subordinate/intermediate certificate authority.
CertificateAuthorityId *string `mandatory:"false" json:"certificateAuthorityId"`
// The time after which leaf certificate will invalid.
TimeCertValidityEnd *common.SDKTime `mandatory:"false" json:"timeCertValidityEnd"`
// The common name for the leaf certificate.
CommonName *string `mandatory:"false" json:"commonName"`
// The compartmentId of the leaf certificate.
CertCompartmentId *string `mandatory:"false" json:"certCompartmentId"`
// key algorithm for issuing leaf certificate.
CertKeyAlgorithm CertKeyAlgorithmEnum `mandatory:"false" json:"certKeyAlgorithm,omitempty"`
// signature algorithm for issuing leaf certificate.
CertSignatureAlgorithm CertSignatureAlgorithmEnum `mandatory:"false" json:"certSignatureAlgorithm,omitempty"`
// The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m UpdateRoverNodeDetails) String() string
func (m UpdateRoverNodeDetails) 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
UpdateRoverNodeDetailsShippingPreferenceEnum Enum with underlying type: string
type UpdateRoverNodeDetailsShippingPreferenceEnum string
Set of constants representing the allowable values for UpdateRoverNodeDetailsShippingPreferenceEnum
const (
UpdateRoverNodeDetailsShippingPreferenceOracleShipped UpdateRoverNodeDetailsShippingPreferenceEnum = "ORACLE_SHIPPED"
UpdateRoverNodeDetailsShippingPreferenceCustomerPickup UpdateRoverNodeDetailsShippingPreferenceEnum = "CUSTOMER_PICKUP"
)
func GetMappingUpdateRoverNodeDetailsShippingPreferenceEnum(val string) (UpdateRoverNodeDetailsShippingPreferenceEnum, bool)
GetMappingUpdateRoverNodeDetailsShippingPreferenceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateRoverNodeDetailsShippingPreferenceEnumValues() []UpdateRoverNodeDetailsShippingPreferenceEnum
GetUpdateRoverNodeDetailsShippingPreferenceEnumValues Enumerates the set of values for UpdateRoverNodeDetailsShippingPreferenceEnum
UpdateRoverNodeRequest wrapper for the UpdateRoverNode operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/UpdateRoverNode.go.html to see an example of how to use UpdateRoverNodeRequest.
type UpdateRoverNodeRequest struct {
// Unique RoverNode identifier
RoverNodeId *string `mandatory:"true" contributesTo:"path" name:"roverNodeId"`
// The information to be updated.
UpdateRoverNodeDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateRoverNodeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRoverNodeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRoverNodeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRoverNodeRequest) String() string
func (request UpdateRoverNodeRequest) 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
UpdateRoverNodeResponse wrapper for the UpdateRoverNode operation
type UpdateRoverNodeResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoverNode instance
RoverNode `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateRoverNodeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRoverNodeResponse) String() string
WorkRequest A description of workRequest status.
type WorkRequest struct {
// Type of the work request.
OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status WorkRequestOperationStatusEnum `mandatory:"true" json:"status"`
// The unique identifier (OCID) of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
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 fine-grained sub-state of a work request.
StatusDetails *string `mandatory:"false" json:"statusDetails"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestCollection Results of a workRequest search. Contains both workRequest items and other data.
type WorkRequestCollection struct {
// List of workRequests.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestCollection) String() string
func (m WorkRequestCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. Error codes are listed on
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occurred. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection Collection of work request errors.
type WorkRequestErrorCollection struct {
// Work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLog A log message from the execution of a work request.
type WorkRequestLog struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLog) String() string
func (m WorkRequestLog) 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
WorkRequestLogCollection Collection of work request logs.
type WorkRequestLogCollection struct {
// Work request logs.
Items []WorkRequestLog `mandatory:"true" json:"items"`
}
func (m WorkRequestLogCollection) String() string
func (m WorkRequestLogCollection) 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
WorkRequestOperationStatusEnum Enum with underlying type: string
type WorkRequestOperationStatusEnum string
Set of constants representing the allowable values for WorkRequestOperationStatusEnum
const (
WorkRequestOperationStatusAccepted WorkRequestOperationStatusEnum = "ACCEPTED"
WorkRequestOperationStatusInProgress WorkRequestOperationStatusEnum = "IN_PROGRESS"
WorkRequestOperationStatusWaiting WorkRequestOperationStatusEnum = "WAITING"
WorkRequestOperationStatusNeedsAttention WorkRequestOperationStatusEnum = "NEEDS_ATTENTION"
WorkRequestOperationStatusFailed WorkRequestOperationStatusEnum = "FAILED"
WorkRequestOperationStatusSucceeded WorkRequestOperationStatusEnum = "SUCCEEDED"
WorkRequestOperationStatusCanceling WorkRequestOperationStatusEnum = "CANCELING"
WorkRequestOperationStatusCanceled WorkRequestOperationStatusEnum = "CANCELED"
)
func GetMappingWorkRequestOperationStatusEnum(val string) (WorkRequestOperationStatusEnum, bool)
GetMappingWorkRequestOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestOperationStatusEnumValues() []WorkRequestOperationStatusEnum
GetWorkRequestOperationStatusEnumValues Enumerates the set of values for WorkRequestOperationStatusEnum
WorkRequestOperationTypeEnum Enum with underlying type: string
type WorkRequestOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestOperationTypeEnum
const (
WorkRequestOperationTypeAddNodes WorkRequestOperationTypeEnum = "ADD_NODES"
)
func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)
GetMappingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType WorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"`
// The unique identifier (OCID) of the resource that 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"`
// Additional information that helps to explain the resource.
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResourceActionTypeEnum Enum with underlying type: string
type WorkRequestResourceActionTypeEnum string
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum
const (
WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
WorkRequestResourceActionTypeFailed WorkRequestResourceActionTypeEnum = "FAILED"
WorkRequestResourceActionTypeCreated WorkRequestResourceActionTypeEnum = "CREATED"
WorkRequestResourceActionTypeUpdated WorkRequestResourceActionTypeEnum = "UPDATED"
)
func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)
GetMappingWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum
WorkRequestSummary A summary of the work request.
type WorkRequestSummary struct {
// Type of the work request.
OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status WorkRequestOperationStatusEnum `mandatory:"true" json:"status"`
// The unique identifier (OCID) of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
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 fine-grained sub-state of a work request.
StatusDetails *string `mandatory:"false" json:"statusDetails"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestsClient a client for WorkRequests
type WorkRequestsClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewWorkRequestsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestsClient, err error)
NewWorkRequestsClientWithConfigurationProvider Creates a new default WorkRequests client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewWorkRequestsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestsClient, err error)
NewWorkRequestsClientWithOboToken Creates a new default WorkRequests client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client WorkRequestsClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancel the work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()
func (client *WorkRequestsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client WorkRequestsClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client WorkRequestsClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Return a (paginated) list of errors for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client WorkRequestsClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Return a (paginated) list of logs for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client WorkRequestsClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *WorkRequestsClient) SetRegion(region string)
SetRegion overrides the region of this client.