func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetLifecycleDetailsEnumEnumStringValues() []string
GetLifecycleDetailsEnumEnumStringValues Enumerates the set of values in String for LifecycleDetailsEnumEnum
func GetLifecycleStateEnumEnumStringValues() []string
GetLifecycleStateEnumEnumStringValues Enumerates the set of values in String for LifecycleStateEnumEnum
func GetListSubscriptionsLifecycleDetailsEnumStringValues() []string
GetListSubscriptionsLifecycleDetailsEnumStringValues Enumerates the set of values in String for ListSubscriptionsLifecycleDetailsEnum
func GetListSubscriptionsSortByEnumStringValues() []string
GetListSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortByEnum
func GetListSubscriptionsSortOrderEnumStringValues() []string
GetListSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetListingSubscriptionsSortByEnumStringValues() []string
GetListingSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListingSubscriptionsSortByEnum
func GetListingSubscriptionsSortOrderEnumStringValues() []string
GetListingSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListingSubscriptionsSortOrderEnum
func GetMetricTypeEnumStringValues() []string
GetMetricTypeEnumStringValues Enumerates the set of values in String for MetricTypeEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetPricingPlanBillingFrequencyEnumStringValues() []string
GetPricingPlanBillingFrequencyEnumStringValues Enumerates the set of values in String for PricingPlanBillingFrequencyEnum
func GetPricingPlanPlanDurationEnumStringValues() []string
GetPricingPlanPlanDurationEnumStringValues Enumerates the set of values in String for PricingPlanPlanDurationEnum
func GetPricingPlanPlanTypeEnumStringValues() []string
GetPricingPlanPlanTypeEnumStringValues Enumerates the set of values in String for PricingPlanPlanTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetSourceTypeEnumStringValues() []string
GetSourceTypeEnumStringValues Enumerates the set of values in String for SourceTypeEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ActivateSubscriptionDetails Request model for activating a subscription. Contains necessary details to perform the activation.
type ActivateSubscriptionDetails struct {
// The unique identifier of the marketplace product listing.
ProductId *string `mandatory:"true" json:"productId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m ActivateSubscriptionDetails) String() string
func (m ActivateSubscriptionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ActivateSubscriptionRequest wrapper for the ActivateSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ActivateSubscription.go.html to see an example of how to use ActivateSubscriptionRequest.
type ActivateSubscriptionRequest struct {
// The unique identifier for the subscription.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The details for activating the subscription.
ActivateSubscriptionDetails `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 running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ActivateSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ActivateSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ActivateSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ActivateSubscriptionRequest) String() string
func (request ActivateSubscriptionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ActivateSubscriptionResponse wrapper for the ActivateSubscription operation
type ActivateSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The ActivateSubscriptionResult instance
ActivateSubscriptionResult `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response ActivateSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ActivateSubscriptionResponse) String() string
ActivateSubscriptionResult Response model for the activation of a subscription. Includes the details of the activated subscription.
type ActivateSubscriptionResult struct {
// The unique identifier of the activated subscription.
SubscriptionId *string `mandatory:"true" json:"subscriptionId"`
// The subscription name. Must be unique within the compartment. This value can be updated.
DisplayName *string `mandatory:"false" json:"displayName"`
// The start date of the subscription.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// The end date of the subscription.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// The current state of the Subscription.
LifecycleState LifecycleStateEnumEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message that describes the current state of the Subscription in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails LifecycleDetailsEnumEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
}
func (m ActivateSubscriptionResult) String() string
func (m ActivateSubscriptionResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BillingDetails Sku details for billing subscription.
type BillingDetails struct {
// Sku for service.
Sku *string `mandatory:"true" json:"sku"`
// The part's metric.
MetricType MetricTypeEnum `mandatory:"true" json:"metricType"`
// Tha rate of this sku meter.
RateAllocation *float32 `mandatory:"true" json:"rateAllocation"`
// The meters associated with sku.
Meters []Meter `mandatory:"true" json:"meters"`
// Whether this sku is assign to gov product.
HasGovSku *bool `mandatory:"false" json:"hasGovSku"`
}
func (m BillingDetails) String() string
func (m BillingDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an 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/self/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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
ChangeSubscriptionCompartmentDetails The configuration details for the move operation.
type ChangeSubscriptionCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the Subscription to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeSubscriptionCompartmentDetails) String() string
func (m ChangeSubscriptionCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeSubscriptionCompartmentRequest wrapper for the ChangeSubscriptionCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ChangeSubscriptionCompartment.go.html to see an example of how to use ChangeSubscriptionCompartmentRequest.
type ChangeSubscriptionCompartmentRequest struct {
// The unique identifier for the subscription.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The information to be updated.
ChangeSubscriptionCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 running 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 removed 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 ChangeSubscriptionCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeSubscriptionCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeSubscriptionCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeSubscriptionCompartmentRequest) String() string
func (request ChangeSubscriptionCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeSubscriptionCompartmentResponse wrapper for the ChangeSubscriptionCompartment operation
type ChangeSubscriptionCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeSubscriptionCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeSubscriptionCompartmentResponse) String() string
CreateSubscriptionDetails The data to create a Subscription.
type CreateSubscriptionDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the subscription in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenant to create the subscription in.
TenantId *string `mandatory:"true" json:"tenantId"`
SubscriptionDetails *SubscriptionDetails `mandatory:"true" json:"subscriptionDetails"`
// The OCID for the seller in SELF Service.
SellerId *string `mandatory:"true" json:"sellerId"`
// The unique identifier of the marketplace listing in Oracle Cloud Infrastructure.
ProductId *string `mandatory:"true" json:"productId"`
// The subscription name. Must be unique within the compartment. This value can be updated.
DisplayName *string `mandatory:"false" json:"displayName"`
// The type of seller in SELF Service.
SourceType SourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
// Additional details that are specific for this subscription such as activation details.
AdditionalDetails []ExtendedMetadata `mandatory:"false" json:"additionalDetails"`
// The realm from where customer is buying the subscription.
Realm *string `mandatory:"false" json:"realm"`
// The region from where customer is buying the subscription.
Region *string `mandatory:"false" json:"region"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateSubscriptionDetails) String() string
func (m CreateSubscriptionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSubscriptionRequest wrapper for the CreateSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/CreateSubscription.go.html to see an example of how to use CreateSubscriptionRequest.
type CreateSubscriptionRequest struct {
// Details for the new Subscription.
CreateSubscriptionDetails `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 running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 CreateSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSubscriptionRequest) String() string
func (request CreateSubscriptionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSubscriptionResponse wrapper for the CreateSubscription operation
type CreateSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Subscription instance
Subscription `presentIn:"body"`
// URL for the created subscription. The subscription OCID is generated after this request is sent.
Location *string `presentIn:"header" name:"location"`
// Same as location.
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSubscriptionResponse) String() string
DeleteSubscriptionRequest wrapper for the DeleteSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/DeleteSubscription.go.html to see an example of how to use DeleteSubscriptionRequest.
type DeleteSubscriptionRequest struct {
// The unique identifier for the subscription.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 DeleteSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSubscriptionRequest) String() string
func (request DeleteSubscriptionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteSubscriptionResponse wrapper for the DeleteSubscription operation
type DeleteSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSubscriptionResponse) String() string
ExtendedMetadata Additional metadata key/value pairs.
type ExtendedMetadata struct {
// Additional attribute for extendedMetadata.
Key *string `mandatory:"true" json:"key"`
// It contains the value of above key.
Value *string `mandatory:"true" json:"value"`
}
func (m ExtendedMetadata) String() string
func (m ExtendedMetadata) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSubscriptionRequest wrapper for the GetSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/GetSubscription.go.html to see an example of how to use GetSubscriptionRequest.
type GetSubscriptionRequest struct {
// The unique identifier for the subscription.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSubscriptionRequest) String() string
func (request GetSubscriptionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSubscriptionResponse wrapper for the GetSubscription operation
type GetSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Subscription instance
Subscription `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 GetSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSubscriptionResponse) String() string
GetSubscriptionTokenRequest wrapper for the GetSubscriptionToken operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/GetSubscriptionToken.go.html to see an example of how to use GetSubscriptionTokenRequest.
type GetSubscriptionTokenRequest struct {
// The unique identifier for the subscription.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetSubscriptionTokenRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSubscriptionTokenRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSubscriptionTokenRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSubscriptionTokenRequest) String() string
func (request GetSubscriptionTokenRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSubscriptionTokenResponse wrapper for the GetSubscriptionToken operation
type GetSubscriptionTokenResponse struct {
// The underlying http response
RawResponse *http.Response
// The SubscriptionToken instance
SubscriptionToken `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response GetSubscriptionTokenResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSubscriptionTokenResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
LifecycleDetailsEnumEnum Enum with underlying type: string
type LifecycleDetailsEnumEnum string
Set of constants representing the allowable values for LifecycleDetailsEnumEnum
const (
LifecycleDetailsEnumCreated LifecycleDetailsEnumEnum = "CREATED"
LifecycleDetailsEnumPendingActivation LifecycleDetailsEnumEnum = "PENDING_ACTIVATION"
LifecycleDetailsEnumProvisioningStarted LifecycleDetailsEnumEnum = "PROVISIONING_STARTED"
LifecycleDetailsEnumProvisioningCompleted LifecycleDetailsEnumEnum = "PROVISIONING_COMPLETED"
LifecycleDetailsEnumProvisioningFailed LifecycleDetailsEnumEnum = "PROVISIONING_FAILED"
LifecycleDetailsEnumActive LifecycleDetailsEnumEnum = "ACTIVE"
LifecycleDetailsEnumExpired LifecycleDetailsEnumEnum = "EXPIRED"
LifecycleDetailsEnumTerminated LifecycleDetailsEnumEnum = "TERMINATED"
LifecycleDetailsEnumFailed LifecycleDetailsEnumEnum = "FAILED"
LifecycleDetailsEnumDeleting LifecycleDetailsEnumEnum = "DELETING"
LifecycleDetailsEnumUpdating LifecycleDetailsEnumEnum = "UPDATING"
LifecycleDetailsEnumDeleted LifecycleDetailsEnumEnum = "DELETED"
)
func GetLifecycleDetailsEnumEnumValues() []LifecycleDetailsEnumEnum
GetLifecycleDetailsEnumEnumValues Enumerates the set of values for LifecycleDetailsEnumEnum
func GetMappingLifecycleDetailsEnumEnum(val string) (LifecycleDetailsEnumEnum, bool)
GetMappingLifecycleDetailsEnumEnum performs case Insensitive comparison on enum value and return the desired enum
LifecycleStateEnumEnum Enum with underlying type: string
type LifecycleStateEnumEnum string
Set of constants representing the allowable values for LifecycleStateEnumEnum
const (
LifecycleStateEnumActive LifecycleStateEnumEnum = "ACTIVE"
LifecycleStateEnumInactive LifecycleStateEnumEnum = "INACTIVE"
LifecycleStateEnumDeleted LifecycleStateEnumEnum = "DELETED"
LifecycleStateEnumFailed LifecycleStateEnumEnum = "FAILED"
)
func GetLifecycleStateEnumEnumValues() []LifecycleStateEnumEnum
GetLifecycleStateEnumEnumValues Enumerates the set of values for LifecycleStateEnumEnum
func GetMappingLifecycleStateEnumEnum(val string) (LifecycleStateEnumEnum, bool)
GetMappingLifecycleStateEnumEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionsLifecycleDetailsEnum Enum with underlying type: string
type ListSubscriptionsLifecycleDetailsEnum string
Set of constants representing the allowable values for ListSubscriptionsLifecycleDetailsEnum
const (
ListSubscriptionsLifecycleDetailsCreated ListSubscriptionsLifecycleDetailsEnum = "CREATED"
ListSubscriptionsLifecycleDetailsPendingActivation ListSubscriptionsLifecycleDetailsEnum = "PENDING_ACTIVATION"
ListSubscriptionsLifecycleDetailsProvisioningStarted ListSubscriptionsLifecycleDetailsEnum = "PROVISIONING_STARTED"
ListSubscriptionsLifecycleDetailsProvisioningCompleted ListSubscriptionsLifecycleDetailsEnum = "PROVISIONING_COMPLETED"
ListSubscriptionsLifecycleDetailsProvisioningFailed ListSubscriptionsLifecycleDetailsEnum = "PROVISIONING_FAILED"
ListSubscriptionsLifecycleDetailsActive ListSubscriptionsLifecycleDetailsEnum = "ACTIVE"
ListSubscriptionsLifecycleDetailsExpired ListSubscriptionsLifecycleDetailsEnum = "EXPIRED"
ListSubscriptionsLifecycleDetailsTerminated ListSubscriptionsLifecycleDetailsEnum = "TERMINATED"
ListSubscriptionsLifecycleDetailsFailed ListSubscriptionsLifecycleDetailsEnum = "FAILED"
ListSubscriptionsLifecycleDetailsDeleting ListSubscriptionsLifecycleDetailsEnum = "DELETING"
ListSubscriptionsLifecycleDetailsUpdating ListSubscriptionsLifecycleDetailsEnum = "UPDATING"
ListSubscriptionsLifecycleDetailsDeleted ListSubscriptionsLifecycleDetailsEnum = "DELETED"
)
func GetListSubscriptionsLifecycleDetailsEnumValues() []ListSubscriptionsLifecycleDetailsEnum
GetListSubscriptionsLifecycleDetailsEnumValues Enumerates the set of values for ListSubscriptionsLifecycleDetailsEnum
func GetMappingListSubscriptionsLifecycleDetailsEnum(val string) (ListSubscriptionsLifecycleDetailsEnum, bool)
GetMappingListSubscriptionsLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionsRequest wrapper for the ListSubscriptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListSubscriptions.go.html to see an example of how to use ListSubscriptionsRequest.
type ListSubscriptionsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the given lifecycle state. The
// state value is case-insensitive.
LifecycleDetails ListSubscriptionsLifecycleDetailsEnum `mandatory:"false" contributesTo:"query" name:"lifecycleDetails" omitEmpty:"true"`
// A filter to return only resources that match the given name.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Subscription.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListSubscriptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided.
SortBy ListSubscriptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ListSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSubscriptionsRequest) String() string
func (request ListSubscriptionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSubscriptionsResponse wrapper for the ListSubscriptions operation
type ListSubscriptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SubscriptionCollection instances
SubscriptionCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListSubscriptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSubscriptionsResponse) String() string
ListSubscriptionsSortByEnum Enum with underlying type: string
type ListSubscriptionsSortByEnum string
Set of constants representing the allowable values for ListSubscriptionsSortByEnum
const (
ListSubscriptionsSortByTimecreated ListSubscriptionsSortByEnum = "timeCreated"
ListSubscriptionsSortByDisplayname ListSubscriptionsSortByEnum = "displayName"
ListSubscriptionsSortBySelftokenid ListSubscriptionsSortByEnum = "selfTokenId"
ListSubscriptionsSortByProductid ListSubscriptionsSortByEnum = "productId"
)
func GetListSubscriptionsSortByEnumValues() []ListSubscriptionsSortByEnum
GetListSubscriptionsSortByEnumValues Enumerates the set of values for ListSubscriptionsSortByEnum
func GetMappingListSubscriptionsSortByEnum(val string) (ListSubscriptionsSortByEnum, bool)
GetMappingListSubscriptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionsSortOrderEnum Enum with underlying type: string
type ListSubscriptionsSortOrderEnum string
Set of constants representing the allowable values for ListSubscriptionsSortOrderEnum
const (
ListSubscriptionsSortOrderAsc ListSubscriptionsSortOrderEnum = "ASC"
ListSubscriptionsSortOrderDesc ListSubscriptionsSortOrderEnum = "DESC"
)
func GetListSubscriptionsSortOrderEnumValues() []ListSubscriptionsSortOrderEnum
GetListSubscriptionsSortOrderEnumValues Enumerates the set of values for ListSubscriptionsSortOrderEnum
func GetMappingListSubscriptionsSortOrderEnum(val string) (ListSubscriptionsSortOrderEnum, bool)
GetMappingListSubscriptionsSortOrderEnum 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/self/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)
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/self/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only the resources that match the given lifecycle state.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
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
ListingSubscriptionSummary The summary information about a Subscription.
type ListingSubscriptionSummary struct {
// The subscription name. Must be unique within the compartment. This value can be updated.
DisplayName *string `mandatory:"true" json:"displayName"`
// The unique identifier of marketplace listing in Oracle Cloud Infrastructure.
ProductId *string `mandatory:"false" json:"productId"`
// The date and time the Subscription was started, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the Subscription was ended, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// The current state of the Subscription.
LifecycleState LifecycleStateEnumEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message that describes the current state of the Subscription in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails LifecycleDetailsEnumEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ListingSubscriptionSummary) String() string
func (m ListingSubscriptionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListingSubscriptionsCollection Results of a subscription search. Contains both SubscriptionSummary items and other information, such as metadata.
type ListingSubscriptionsCollection struct {
// List of subscriptions for particular listing.
Items []ListingSubscriptionSummary `mandatory:"true" json:"items"`
}
func (m ListingSubscriptionsCollection) String() string
func (m ListingSubscriptionsCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListingSubscriptionsRequest wrapper for the ListingSubscriptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListingSubscriptions.go.html to see an example of how to use ListingSubscriptionsRequest.
type ListingSubscriptionsRequest struct {
// The unique identifier for the listing.
ListingId *string `mandatory:"true" contributesTo:"query" name:"listingId"`
// A filter to return only resources that match the given name.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The field to sort by. Only one sort order may be provided.
SortBy ListingSubscriptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListingSubscriptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListingSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListingSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListingSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListingSubscriptionsRequest) String() string
func (request ListingSubscriptionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListingSubscriptionsResponse wrapper for the ListingSubscriptions operation
type ListingSubscriptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ListingSubscriptionsCollection instances
ListingSubscriptionsCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListingSubscriptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListingSubscriptionsResponse) String() string
ListingSubscriptionsSortByEnum Enum with underlying type: string
type ListingSubscriptionsSortByEnum string
Set of constants representing the allowable values for ListingSubscriptionsSortByEnum
const (
ListingSubscriptionsSortByTimecreated ListingSubscriptionsSortByEnum = "timeCreated"
ListingSubscriptionsSortByDisplayname ListingSubscriptionsSortByEnum = "displayName"
ListingSubscriptionsSortBySelftokenid ListingSubscriptionsSortByEnum = "selfTokenId"
ListingSubscriptionsSortByProductid ListingSubscriptionsSortByEnum = "productId"
)
func GetListingSubscriptionsSortByEnumValues() []ListingSubscriptionsSortByEnum
GetListingSubscriptionsSortByEnumValues Enumerates the set of values for ListingSubscriptionsSortByEnum
func GetMappingListingSubscriptionsSortByEnum(val string) (ListingSubscriptionsSortByEnum, bool)
GetMappingListingSubscriptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListingSubscriptionsSortOrderEnum Enum with underlying type: string
type ListingSubscriptionsSortOrderEnum string
Set of constants representing the allowable values for ListingSubscriptionsSortOrderEnum
const (
ListingSubscriptionsSortOrderAsc ListingSubscriptionsSortOrderEnum = "ASC"
ListingSubscriptionsSortOrderDesc ListingSubscriptionsSortOrderEnum = "DESC"
)
func GetListingSubscriptionsSortOrderEnumValues() []ListingSubscriptionsSortOrderEnum
GetListingSubscriptionsSortOrderEnumValues Enumerates the set of values for ListingSubscriptionsSortOrderEnum
func GetMappingListingSubscriptionsSortOrderEnum(val string) (ListingSubscriptionsSortOrderEnum, bool)
GetMappingListingSubscriptionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
Meter Details provide by seller for activation of its product.
type Meter struct {
// Name of meter.
Name *string `mandatory:"true" json:"name"`
// Tha rate of this sku meter.
RateAllocation *float32 `mandatory:"true" json:"rateAllocation"`
// Additional data give by sku.
ExtendedMetadata []ExtendedMetadata `mandatory:"false" json:"extendedMetadata"`
}
func (m Meter) String() string
func (m Meter) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MetricTypeEnum Enum with underlying type: string
type MetricTypeEnum string
Set of constants representing the allowable values for MetricTypeEnum
const (
MetricTypeOcpuHours MetricTypeEnum = "OCPU_HOURS"
MetricTypeInstanceHours MetricTypeEnum = "INSTANCE_HOURS"
MetricTypeCoreHours MetricTypeEnum = "CORE_HOURS"
)
func GetMappingMetricTypeEnum(val string) (MetricTypeEnum, bool)
GetMappingMetricTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMetricTypeEnumValues() []MetricTypeEnum
GetMetricTypeEnumValues Enumerates the set of values for MetricTypeEnum
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateSubscription OperationTypeEnum = "CREATE_SUBSCRIPTION"
OperationTypeUpdateSubscription OperationTypeEnum = "UPDATE_SUBSCRIPTION"
OperationTypeDeleteSubscription OperationTypeEnum = "DELETE_SUBSCRIPTION"
OperationTypeMoveSubscription OperationTypeEnum = "MOVE_SUBSCRIPTION"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
PartnerIntegerationClient a client for PartnerIntegeration
type PartnerIntegerationClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewPartnerIntegerationClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client PartnerIntegerationClient, err error)
NewPartnerIntegerationClientWithConfigurationProvider Creates a new default PartnerIntegeration client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewPartnerIntegerationClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client PartnerIntegerationClient, err error)
NewPartnerIntegerationClientWithOboToken Creates a new default PartnerIntegeration 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 PartnerIntegerationClient) ActivateSubscription(ctx context.Context, request ActivateSubscriptionRequest) (response ActivateSubscriptionResponse, err error)
ActivateSubscription Activates a subscription identified by the provided subscription ID and updates its status.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ActivateSubscription.go.html to see an example of how to use ActivateSubscription API. A default retry strategy applies to this operation ActivateSubscription()
func (client *PartnerIntegerationClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client PartnerIntegerationClient) ListingSubscriptions(ctx context.Context, request ListingSubscriptionsRequest) (response ListingSubscriptionsResponse, err error)
ListingSubscriptions Gets information about a Subscription.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListingSubscriptions.go.html to see an example of how to use ListingSubscriptions API. A default retry strategy applies to this operation ListingSubscriptions()
func (client PartnerIntegerationClient) ResolveSubscription(ctx context.Context, request ResolveSubscriptionRequest) (response ResolveSubscriptionResponse, err error)
ResolveSubscription This API returns the subscription details by resolving JWT token to corresponding subscription and move its state to Pending Activation state.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ResolveSubscription.go.html to see an example of how to use ResolveSubscription API. A default retry strategy applies to this operation ResolveSubscription()
func (client *PartnerIntegerationClient) SetRegion(region string)
SetRegion overrides the region of this client.
PartnerSubscription These api for partner to communicate to OCI.
type PartnerSubscription struct {
// The unique identifier of the Subscription.
SubscriptionId *string `mandatory:"true" json:"subscriptionId"`
// The subscription name. Must be unique within the compartment. This value can be updated.
DisplayName *string `mandatory:"false" json:"displayName"`
PricingPlan *PricingPlan `mandatory:"false" json:"pricingPlan"`
// The type of seller in SELF Service.
SourceType SourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
// The unique OCID of the product, effectively functioning as the listing ID.
ProductId *string `mandatory:"false" json:"productId"`
// Whether subscription should be auto-renewed at the end of cycle.
IsAutoRenew *bool `mandatory:"false" json:"isAutoRenew"`
// Additional details that are specific for this subscription such as activation details.
AdditionalDetails []ExtendedMetadata `mandatory:"false" json:"additionalDetails"`
// The current state of the Subscription.
LifecycleState LifecycleStateEnumEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message that describes the current state of the Subscription in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails LifecycleDetailsEnumEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
// The date and time the Subscription was started, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the Subscription was ended, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// The date and time the Subscription was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the Subscription was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m PartnerSubscription) String() string
func (m PartnerSubscription) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PricingPlan A pricing plan details provided by the Publisher.
type PricingPlan struct {
// The type of the subscription plan.
PlanType PricingPlanPlanTypeEnum `mandatory:"true" json:"planType"`
// The name of the subscription plan used to identify the plan.
PlanName *string `mandatory:"true" json:"planName"`
// Specifies the interval at which billing occurs for the subscription plan.
BillingFrequency PricingPlanBillingFrequencyEnum `mandatory:"true" json:"billingFrequency"`
// The pricing details of the subscription plan in various supported currencies.
Rates []PricingRate `mandatory:"true" json:"rates"`
// A detailed explanation of the subscription plan.
PlanDescription *string `mandatory:"false" json:"planDescription"`
// Specifies the interval at which billing occurs for the subscription plan.
PlanDuration PricingPlanPlanDurationEnum `mandatory:"false" json:"planDuration,omitempty"`
}
func (m PricingPlan) String() string
func (m PricingPlan) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PricingPlanBillingFrequencyEnum Enum with underlying type: string
type PricingPlanBillingFrequencyEnum string
Set of constants representing the allowable values for PricingPlanBillingFrequencyEnum
const (
PricingPlanBillingFrequencyYearly PricingPlanBillingFrequencyEnum = "YEARLY"
)
func GetMappingPricingPlanBillingFrequencyEnum(val string) (PricingPlanBillingFrequencyEnum, bool)
GetMappingPricingPlanBillingFrequencyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPricingPlanBillingFrequencyEnumValues() []PricingPlanBillingFrequencyEnum
GetPricingPlanBillingFrequencyEnumValues Enumerates the set of values for PricingPlanBillingFrequencyEnum
PricingPlanPlanDurationEnum Enum with underlying type: string
type PricingPlanPlanDurationEnum string
Set of constants representing the allowable values for PricingPlanPlanDurationEnum
const (
PricingPlanPlanDurationAnnual PricingPlanPlanDurationEnum = "ANNUAL"
)
func GetMappingPricingPlanPlanDurationEnum(val string) (PricingPlanPlanDurationEnum, bool)
GetMappingPricingPlanPlanDurationEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPricingPlanPlanDurationEnumValues() []PricingPlanPlanDurationEnum
GetPricingPlanPlanDurationEnumValues Enumerates the set of values for PricingPlanPlanDurationEnum
PricingPlanPlanTypeEnum Enum with underlying type: string
type PricingPlanPlanTypeEnum string
Set of constants representing the allowable values for PricingPlanPlanTypeEnum
const (
PricingPlanPlanTypeFixed PricingPlanPlanTypeEnum = "FIXED"
)
func GetMappingPricingPlanPlanTypeEnum(val string) (PricingPlanPlanTypeEnum, bool)
GetMappingPricingPlanPlanTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPricingPlanPlanTypeEnumValues() []PricingPlanPlanTypeEnum
GetPricingPlanPlanTypeEnumValues Enumerates the set of values for PricingPlanPlanTypeEnum
PricingRate A pricing plan rate provided by the Publisher.
type PricingRate struct {
// The currency supported, in the format specified by ISO-4217
Currency *string `mandatory:"true" json:"currency"`
// The amount charged for the plan in the specified currency.
Rate *float32 `mandatory:"true" json:"rate"`
}
func (m PricingRate) String() string
func (m PricingRate) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResolveSubscriptionDetails Request model used to resolve and retrieve subscription details for a customer subscription, given a selfToken and the productId.
type ResolveSubscriptionDetails struct {
// The base 64 encoded JWT token which is mapped to a particular subscription
SelfToken *string `mandatory:"true" json:"selfToken"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the marketplace product listing.
ProductId *string `mandatory:"true" json:"productId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m ResolveSubscriptionDetails) String() string
func (m ResolveSubscriptionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResolveSubscriptionRequest wrapper for the ResolveSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ResolveSubscription.go.html to see an example of how to use ResolveSubscriptionRequest.
type ResolveSubscriptionRequest struct {
// Details for the new Subscription.
ResolveSubscriptionDetails `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 running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ResolveSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ResolveSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ResolveSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ResolveSubscriptionRequest) String() string
func (request ResolveSubscriptionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResolveSubscriptionResponse wrapper for the ResolveSubscription operation
type ResolveSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The PartnerSubscription instance
PartnerSubscription `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response ResolveSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ResolveSubscriptionResponse) String() string
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
SourceTypeEnum Enum with underlying type: string
type SourceTypeEnum string
Set of constants representing the allowable values for SourceTypeEnum
const (
SourceTypeOciNative SourceTypeEnum = "OCI_NATIVE"
SourceTypeThirdParty SourceTypeEnum = "THIRD_PARTY"
)
func GetMappingSourceTypeEnum(val string) (SourceTypeEnum, bool)
GetMappingSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSourceTypeEnumValues() []SourceTypeEnum
GetSourceTypeEnumValues Enumerates the set of values for SourceTypeEnum
Subscription The model for a listing subscription.
type Subscription struct {
// The unique identifier for the subscription within a specific compartment.
Id *string `mandatory:"true" json:"id"`
// The subscription name. Must be unique within the compartment. This value can be updated.
DisplayName *string `mandatory:"true" json:"displayName"`
// The unique identifier for the compartment where the subscription was purchased.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The unique identifier for the tenant where the subscription was purchased.
TenantId *string `mandatory:"true" json:"tenantId"`
// The date and time the Subscription was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current lifecycle state of the Subscription.
LifecycleState LifecycleStateEnumEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
SubscriptionDetails *SubscriptionDetails `mandatory:"false" json:"subscriptionDetails"`
// The OCID that identifies the seller within the platform.
SellerId *string `mandatory:"false" json:"sellerId"`
// The type of seller in SELF Service.
SourceType SourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
// The unique OCID of the product, effectively functioning as the listing ID.
ProductId *string `mandatory:"false" json:"productId"`
// Additional details that are specific for this subscription such as activation details.
AdditionalDetails []ExtendedMetadata `mandatory:"false" json:"additionalDetails"`
// The realm from where customer is buying the subscription.
Realm *string `mandatory:"false" json:"realm"`
// The region from where customer is buying the subscription.
Region *string `mandatory:"false" json:"region"`
// The date and time the Subscription was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The date and time the Subscription was started, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the Subscription was ended, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// A message that describes the current state of the Subscription in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails LifecycleDetailsEnumEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Subscription) String() string
func (m Subscription) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscriptionClient a client for Subscription
type SubscriptionClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewSubscriptionClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SubscriptionClient, err error)
NewSubscriptionClientWithConfigurationProvider Creates a new default Subscription client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewSubscriptionClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SubscriptionClient, err error)
NewSubscriptionClientWithOboToken Creates a new default Subscription 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 SubscriptionClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancels a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()
func (client SubscriptionClient) ChangeSubscriptionCompartment(ctx context.Context, request ChangeSubscriptionCompartmentRequest) (response ChangeSubscriptionCompartmentResponse, err error)
ChangeSubscriptionCompartment Moves a Subscription into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ChangeSubscriptionCompartment.go.html to see an example of how to use ChangeSubscriptionCompartment API. A default retry strategy applies to this operation ChangeSubscriptionCompartment()
func (client *SubscriptionClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client SubscriptionClient) CreateSubscription(ctx context.Context, request CreateSubscriptionRequest) (response CreateSubscriptionResponse, err error)
CreateSubscription Creates a Subscription.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/CreateSubscription.go.html to see an example of how to use CreateSubscription API. A default retry strategy applies to this operation CreateSubscription()
func (client SubscriptionClient) DeleteSubscription(ctx context.Context, request DeleteSubscriptionRequest) (response DeleteSubscriptionResponse, err error)
DeleteSubscription Deletes a Subscription.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/DeleteSubscription.go.html to see an example of how to use DeleteSubscription API. A default retry strategy applies to this operation DeleteSubscription()
func (client SubscriptionClient) GetSubscription(ctx context.Context, request GetSubscriptionRequest) (response GetSubscriptionResponse, err error)
GetSubscription Gets information about a Subscription.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/GetSubscription.go.html to see an example of how to use GetSubscription API. A default retry strategy applies to this operation GetSubscription()
func (client SubscriptionClient) GetSubscriptionToken(ctx context.Context, request GetSubscriptionTokenRequest) (response GetSubscriptionTokenResponse, err error)
GetSubscriptionToken Gets a token of Subscriptions.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/GetSubscriptionToken.go.html to see an example of how to use GetSubscriptionToken API. A default retry strategy applies to this operation GetSubscriptionToken()
func (client SubscriptionClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the details of a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client SubscriptionClient) ListSubscriptions(ctx context.Context, request ListSubscriptionsRequest) (response ListSubscriptionsResponse, err error)
ListSubscriptions Lists the subscriptions which have been created in the specified compartment. You can filter results by specifying query parameters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListSubscriptions.go.html to see an example of how to use ListSubscriptions API. A default retry strategy applies to this operation ListSubscriptions()
func (client SubscriptionClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists the errors for a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client SubscriptionClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs for a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client SubscriptionClient) 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/self/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *SubscriptionClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client SubscriptionClient) UpdateSubscription(ctx context.Context, request UpdateSubscriptionRequest) (response UpdateSubscriptionResponse, err error)
UpdateSubscription Updates a Subscription.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/UpdateSubscription.go.html to see an example of how to use UpdateSubscription API. A default retry strategy applies to this operation UpdateSubscription()
SubscriptionCollection Results of a subscription search. Contains both SubscriptionSummary items and other information, such as metadata.
type SubscriptionCollection struct {
// List of subscriptions.
Items []SubscriptionSummary `mandatory:"true" json:"items"`
}
func (m SubscriptionCollection) String() string
func (m SubscriptionCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscriptionDetails The details of a subscription
type SubscriptionDetails struct {
PricingPlan *PricingPlan `mandatory:"true" json:"pricingPlan"`
// The activation link given by the partner.
PartnerRegistrationUrl *string `mandatory:"true" json:"partnerRegistrationUrl"`
BillingDetails *BillingDetails `mandatory:"true" json:"billingDetails"`
// The currency supported, in the format specified by ISO-4217
Currency *string `mandatory:"false" json:"currency"`
// Tha amount for the currency type.
Amount *float32 `mandatory:"false" json:"amount"`
// Whether subscription should be auto-renewed at the end of cycle.
IsAutoRenew *bool `mandatory:"false" json:"isAutoRenew"`
}
func (m SubscriptionDetails) String() string
func (m SubscriptionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscriptionSummary The model for a summary of a subscription.
type SubscriptionSummary struct {
// The unique identifier for the subscription within a specific compartment.
Id *string `mandatory:"true" json:"id"`
// The subscription name. Must be unique within the compartment. This value can be updated.
DisplayName *string `mandatory:"true" json:"displayName"`
// The unique identifier for the compartment where subscription was created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The unique identifier for the tenant where the subscription was purchased.
TenantId *string `mandatory:"true" json:"tenantId"`
// The date and time the Subscription was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A message that describes the current state of the Subscription in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails LifecycleDetailsEnumEnum `mandatory:"true" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
SubscriptionDetails *SubscriptionDetails `mandatory:"false" json:"subscriptionDetails"`
// The OCID that identifies the seller within the platform.
SellerId *string `mandatory:"false" json:"sellerId"`
// The unique OCID of the product, effectively functioning as the listing ID.
ProductId *string `mandatory:"false" json:"productId"`
// The date and time the Subscription was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The date and time the Subscription was started, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the Subscription was ended, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// The current state of the Subscription.
LifecycleState LifecycleStateEnumEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m SubscriptionSummary) String() string
func (m SubscriptionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscriptionToken The base 64 encoded JWT token which is mapped to a particular subscription.
type SubscriptionToken struct {
// JWT token of subscriptions.
Token *string `mandatory:"true" json:"token"`
// The unique identifier for the subscription within a specific compartment.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m SubscriptionToken) String() string
func (m SubscriptionToken) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSubscriptionDetails The data to update a Subscription.
type UpdateSubscriptionDetails struct {
// The subscription name. Must be unique within the compartment. This value can be updated.
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateSubscriptionDetails) String() string
func (m UpdateSubscriptionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSubscriptionRequest wrapper for the UpdateSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/UpdateSubscription.go.html to see an example of how to use UpdateSubscriptionRequest.
type UpdateSubscriptionRequest struct {
// The unique identifier for the subscription.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The information to be updated.
UpdateSubscriptionDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 UpdateSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSubscriptionRequest) String() string
func (request UpdateSubscriptionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSubscriptionResponse wrapper for the UpdateSubscription operation
type UpdateSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSubscriptionResponse) String() string
WorkRequest An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.
type WorkRequest struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while performing an operation that is tracked by a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. For a list of error codes, see
// API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// A human-readable error message.
Message *string `mandatory:"true" json:"message"`
// The date and time the error occurred, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection A list of work request errors. Can contain both errors and other information, such as metadata.
type WorkRequestErrorCollection struct {
// A list of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.
type WorkRequestLogEntry struct {
// A human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The date and time the log message was written, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection A list of work request logs. Can contain both logs and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// A list of work request log entries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type that the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the operation tracked in the work request.
// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
// work is complete for that resource, at which point it transitions to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that you can use for a GET request to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
// 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
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum
WorkRequestSummary Summary information about an asynchronous work request.
type WorkRequestSummary struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummaryCollection A list of work requests. Can contain both work requests and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// A list of work requests.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly