self

package
v65.121.1 Latest Latest
Warning

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

Go to latest
Published: Jul 21, 2026 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetLifecycleDetailsEnumEnumStringValues

func GetLifecycleDetailsEnumEnumStringValues() []string

GetLifecycleDetailsEnumEnumStringValues Enumerates the set of values in String for LifecycleDetailsEnumEnum

func GetLifecycleStateEnumEnumStringValues

func GetLifecycleStateEnumEnumStringValues() []string

GetLifecycleStateEnumEnumStringValues Enumerates the set of values in String for LifecycleStateEnumEnum

func GetListSubscriptionsLifecycleDetailsEnumStringValues

func GetListSubscriptionsLifecycleDetailsEnumStringValues() []string

GetListSubscriptionsLifecycleDetailsEnumStringValues Enumerates the set of values in String for ListSubscriptionsLifecycleDetailsEnum

func GetListSubscriptionsSortByEnumStringValues

func GetListSubscriptionsSortByEnumStringValues() []string

GetListSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortByEnum

func GetListSubscriptionsSortOrderEnumStringValues

func GetListSubscriptionsSortOrderEnumStringValues() []string

GetListSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetListingSubscriptionsSortByEnumStringValues

func GetListingSubscriptionsSortByEnumStringValues() []string

GetListingSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListingSubscriptionsSortByEnum

func GetListingSubscriptionsSortOrderEnumStringValues

func GetListingSubscriptionsSortOrderEnumStringValues() []string

GetListingSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListingSubscriptionsSortOrderEnum

func GetMetricTypeEnumStringValues

func GetMetricTypeEnumStringValues() []string

GetMetricTypeEnumStringValues Enumerates the set of values in String for MetricTypeEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetPricingPlanBillingFrequencyEnumStringValues

func GetPricingPlanBillingFrequencyEnumStringValues() []string

GetPricingPlanBillingFrequencyEnumStringValues Enumerates the set of values in String for PricingPlanBillingFrequencyEnum

func GetPricingPlanPlanDurationEnumStringValues

func GetPricingPlanPlanDurationEnumStringValues() []string

GetPricingPlanPlanDurationEnumStringValues Enumerates the set of values in String for PricingPlanPlanDurationEnum

func GetPricingPlanPlanTypeEnumStringValues

func GetPricingPlanPlanTypeEnumStringValues() []string

GetPricingPlanPlanTypeEnumStringValues Enumerates the set of values in String for PricingPlanPlanTypeEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetSourceTypeEnumStringValues

func GetSourceTypeEnumStringValues() []string

GetSourceTypeEnumStringValues Enumerates the set of values in String for SourceTypeEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

Types

type ActionTypeEnum

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type ActivateSubscriptionDetails

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

ActivateSubscriptionDetails Request model for activating a subscription. Contains necessary details to perform the activation.

func (ActivateSubscriptionDetails) String

func (ActivateSubscriptionDetails) ValidateEnumValue

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

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

ActivateSubscriptionRequest wrapper for the ActivateSubscription operation

See also

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.

func (ActivateSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ActivateSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ActivateSubscriptionRequest) RetryPolicy

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

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

func (ActivateSubscriptionRequest) String

func (request ActivateSubscriptionRequest) String() string

func (ActivateSubscriptionRequest) ValidateEnumValue

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

type ActivateSubscriptionResponse

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

ActivateSubscriptionResponse wrapper for the ActivateSubscription operation

func (ActivateSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ActivateSubscriptionResponse) String

func (response ActivateSubscriptionResponse) String() string

type ActivateSubscriptionResult

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

ActivateSubscriptionResult Response model for the activation of a subscription. Includes the details of the activated subscription.

func (ActivateSubscriptionResult) String

func (ActivateSubscriptionResult) ValidateEnumValue

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

type BillingDetails

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

BillingDetails Sku details for billing subscription.

func (BillingDetails) String

func (m BillingDetails) String() string

func (BillingDetails) ValidateEnumValue

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

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

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

See also

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.

func (CancelWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CancelWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy

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

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

func (CancelWorkRequestRequest) String

func (request CancelWorkRequestRequest) String() string

func (CancelWorkRequestRequest) ValidateEnumValue

func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CancelWorkRequestResponse

type CancelWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

func (CancelWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String

func (response CancelWorkRequestResponse) String() string

type ChangeSubscriptionCompartmentDetails

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

ChangeSubscriptionCompartmentDetails The configuration details for the move operation.

func (ChangeSubscriptionCompartmentDetails) String

func (ChangeSubscriptionCompartmentDetails) ValidateEnumValue

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

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

ChangeSubscriptionCompartmentRequest wrapper for the ChangeSubscriptionCompartment operation

See also

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.

func (ChangeSubscriptionCompartmentRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeSubscriptionCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeSubscriptionCompartmentRequest) RetryPolicy

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

func (ChangeSubscriptionCompartmentRequest) String

func (ChangeSubscriptionCompartmentRequest) ValidateEnumValue

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

type ChangeSubscriptionCompartmentResponse

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

ChangeSubscriptionCompartmentResponse wrapper for the ChangeSubscriptionCompartment operation

func (ChangeSubscriptionCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeSubscriptionCompartmentResponse) String

type CreateSubscriptionDetails

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

CreateSubscriptionDetails The data to create a Subscription.

func (CreateSubscriptionDetails) String

func (m CreateSubscriptionDetails) String() string

func (CreateSubscriptionDetails) ValidateEnumValue

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

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

CreateSubscriptionRequest wrapper for the CreateSubscription operation

See also

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.

func (CreateSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateSubscriptionRequest) RetryPolicy

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

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

func (CreateSubscriptionRequest) String

func (request CreateSubscriptionRequest) String() string

func (CreateSubscriptionRequest) ValidateEnumValue

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

type CreateSubscriptionResponse

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

CreateSubscriptionResponse wrapper for the CreateSubscription operation

func (CreateSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateSubscriptionResponse) String

func (response CreateSubscriptionResponse) String() string

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

DeleteSubscriptionRequest wrapper for the DeleteSubscription operation

See also

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.

func (DeleteSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteSubscriptionRequest) RetryPolicy

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

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

func (DeleteSubscriptionRequest) String

func (request DeleteSubscriptionRequest) String() string

func (DeleteSubscriptionRequest) ValidateEnumValue

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

type DeleteSubscriptionResponse

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

DeleteSubscriptionResponse wrapper for the DeleteSubscription operation

func (DeleteSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteSubscriptionResponse) String

func (response DeleteSubscriptionResponse) String() string

type ExtendedMetadata

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

ExtendedMetadata Additional metadata key/value pairs.

func (ExtendedMetadata) String

func (m ExtendedMetadata) String() string

func (ExtendedMetadata) ValidateEnumValue

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

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

GetSubscriptionRequest wrapper for the GetSubscription operation

See also

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.

func (GetSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetSubscriptionRequest) RetryPolicy

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

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

func (GetSubscriptionRequest) String

func (request GetSubscriptionRequest) String() string

func (GetSubscriptionRequest) ValidateEnumValue

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

type GetSubscriptionResponse

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

GetSubscriptionResponse wrapper for the GetSubscription operation

func (GetSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetSubscriptionResponse) String

func (response GetSubscriptionResponse) String() string

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

GetSubscriptionTokenRequest wrapper for the GetSubscriptionToken operation

See also

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.

func (GetSubscriptionTokenRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetSubscriptionTokenRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetSubscriptionTokenRequest) RetryPolicy

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

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

func (GetSubscriptionTokenRequest) String

func (request GetSubscriptionTokenRequest) String() string

func (GetSubscriptionTokenRequest) ValidateEnumValue

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

type GetSubscriptionTokenResponse

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

GetSubscriptionTokenResponse wrapper for the GetSubscriptionToken operation

func (GetSubscriptionTokenResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetSubscriptionTokenResponse) String

func (response GetSubscriptionTokenResponse) String() string

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

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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.

func (GetWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetWorkRequestResponse

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The WorkRequest instance
	WorkRequest `presentIn:"body"`

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type LifecycleDetailsEnumEnum

type LifecycleDetailsEnumEnum string

LifecycleDetailsEnumEnum Enum with underlying type: string

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

Set of constants representing the allowable values for LifecycleDetailsEnumEnum

func GetLifecycleDetailsEnumEnumValues

func GetLifecycleDetailsEnumEnumValues() []LifecycleDetailsEnumEnum

GetLifecycleDetailsEnumEnumValues Enumerates the set of values for LifecycleDetailsEnumEnum

func GetMappingLifecycleDetailsEnumEnum

func GetMappingLifecycleDetailsEnumEnum(val string) (LifecycleDetailsEnumEnum, bool)

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

type LifecycleStateEnumEnum

type LifecycleStateEnumEnum string

LifecycleStateEnumEnum Enum with underlying type: string

const (
	LifecycleStateEnumActive   LifecycleStateEnumEnum = "ACTIVE"
	LifecycleStateEnumInactive LifecycleStateEnumEnum = "INACTIVE"
	LifecycleStateEnumDeleted  LifecycleStateEnumEnum = "DELETED"
	LifecycleStateEnumFailed   LifecycleStateEnumEnum = "FAILED"
)

Set of constants representing the allowable values for LifecycleStateEnumEnum

func GetLifecycleStateEnumEnumValues

func GetLifecycleStateEnumEnumValues() []LifecycleStateEnumEnum

GetLifecycleStateEnumEnumValues Enumerates the set of values for LifecycleStateEnumEnum

func GetMappingLifecycleStateEnumEnum

func GetMappingLifecycleStateEnumEnum(val string) (LifecycleStateEnumEnum, bool)

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

type ListSubscriptionsLifecycleDetailsEnum

type ListSubscriptionsLifecycleDetailsEnum string

ListSubscriptionsLifecycleDetailsEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListSubscriptionsLifecycleDetailsEnum

func GetListSubscriptionsLifecycleDetailsEnumValues

func GetListSubscriptionsLifecycleDetailsEnumValues() []ListSubscriptionsLifecycleDetailsEnum

GetListSubscriptionsLifecycleDetailsEnumValues Enumerates the set of values for ListSubscriptionsLifecycleDetailsEnum

func GetMappingListSubscriptionsLifecycleDetailsEnum

func GetMappingListSubscriptionsLifecycleDetailsEnum(val string) (ListSubscriptionsLifecycleDetailsEnum, bool)

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

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

ListSubscriptionsRequest wrapper for the ListSubscriptions operation

See also

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.

func (ListSubscriptionsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListSubscriptionsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListSubscriptionsRequest) RetryPolicy

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

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

func (ListSubscriptionsRequest) String

func (request ListSubscriptionsRequest) String() string

func (ListSubscriptionsRequest) ValidateEnumValue

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

type ListSubscriptionsResponse

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

ListSubscriptionsResponse wrapper for the ListSubscriptions operation

func (ListSubscriptionsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListSubscriptionsResponse) String

func (response ListSubscriptionsResponse) String() string

type ListSubscriptionsSortByEnum

type ListSubscriptionsSortByEnum string

ListSubscriptionsSortByEnum Enum with underlying type: string

const (
	ListSubscriptionsSortByTimecreated ListSubscriptionsSortByEnum = "timeCreated"
	ListSubscriptionsSortByDisplayname ListSubscriptionsSortByEnum = "displayName"
	ListSubscriptionsSortBySelftokenid ListSubscriptionsSortByEnum = "selfTokenId"
	ListSubscriptionsSortByProductid   ListSubscriptionsSortByEnum = "productId"
)

Set of constants representing the allowable values for ListSubscriptionsSortByEnum

func GetListSubscriptionsSortByEnumValues

func GetListSubscriptionsSortByEnumValues() []ListSubscriptionsSortByEnum

GetListSubscriptionsSortByEnumValues Enumerates the set of values for ListSubscriptionsSortByEnum

func GetMappingListSubscriptionsSortByEnum

func GetMappingListSubscriptionsSortByEnum(val string) (ListSubscriptionsSortByEnum, bool)

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

type ListSubscriptionsSortOrderEnum

type ListSubscriptionsSortOrderEnum string

ListSubscriptionsSortOrderEnum Enum with underlying type: string

const (
	ListSubscriptionsSortOrderAsc  ListSubscriptionsSortOrderEnum = "ASC"
	ListSubscriptionsSortOrderDesc ListSubscriptionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSubscriptionsSortOrderEnum

func GetListSubscriptionsSortOrderEnumValues

func GetListSubscriptionsSortOrderEnumValues() []ListSubscriptionsSortOrderEnum

GetListSubscriptionsSortOrderEnumValues Enumerates the set of values for ListSubscriptionsSortOrderEnum

func GetMappingListSubscriptionsSortOrderEnum

func GetMappingListSubscriptionsSortOrderEnum(val string) (ListSubscriptionsSortOrderEnum, bool)

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

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

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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.

func (ListWorkRequestErrorsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestErrorsResponse

type ListWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestErrorCollection instances
	WorkRequestErrorCollection `presentIn:"body"`

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest

type ListWorkRequestLogsRequest struct {

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

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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.

func (ListWorkRequestLogsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestLogsResponse

type ListWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestLogEntryCollection instances
	WorkRequestLogEntryCollection `presentIn:"body"`

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest

type ListWorkRequestsRequest struct {

	// The OCID (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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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.

func (ListWorkRequestsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestsResponse

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestSummaryCollection instances
	WorkRequestSummaryCollection `presentIn:"body"`

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type ListWorkRequestsStatusEnum

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

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

type ListingSubscriptionSummary

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

ListingSubscriptionSummary The summary information about a Subscription.

func (ListingSubscriptionSummary) String

func (ListingSubscriptionSummary) ValidateEnumValue

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

type ListingSubscriptionsCollection

type ListingSubscriptionsCollection struct {

	// List of subscriptions for particular listing.
	Items []ListingSubscriptionSummary `mandatory:"true" json:"items"`
}

ListingSubscriptionsCollection Results of a subscription search. Contains both SubscriptionSummary items and other information, such as metadata.

func (ListingSubscriptionsCollection) String

func (ListingSubscriptionsCollection) ValidateEnumValue

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

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

ListingSubscriptionsRequest wrapper for the ListingSubscriptions operation

See also

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.

func (ListingSubscriptionsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListingSubscriptionsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListingSubscriptionsRequest) RetryPolicy

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

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

func (ListingSubscriptionsRequest) String

func (request ListingSubscriptionsRequest) String() string

func (ListingSubscriptionsRequest) ValidateEnumValue

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

type ListingSubscriptionsResponse

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

ListingSubscriptionsResponse wrapper for the ListingSubscriptions operation

func (ListingSubscriptionsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListingSubscriptionsResponse) String

func (response ListingSubscriptionsResponse) String() string

type ListingSubscriptionsSortByEnum

type ListingSubscriptionsSortByEnum string

ListingSubscriptionsSortByEnum Enum with underlying type: string

const (
	ListingSubscriptionsSortByTimecreated ListingSubscriptionsSortByEnum = "timeCreated"
	ListingSubscriptionsSortByDisplayname ListingSubscriptionsSortByEnum = "displayName"
	ListingSubscriptionsSortBySelftokenid ListingSubscriptionsSortByEnum = "selfTokenId"
	ListingSubscriptionsSortByProductid   ListingSubscriptionsSortByEnum = "productId"
)

Set of constants representing the allowable values for ListingSubscriptionsSortByEnum

func GetListingSubscriptionsSortByEnumValues

func GetListingSubscriptionsSortByEnumValues() []ListingSubscriptionsSortByEnum

GetListingSubscriptionsSortByEnumValues Enumerates the set of values for ListingSubscriptionsSortByEnum

func GetMappingListingSubscriptionsSortByEnum

func GetMappingListingSubscriptionsSortByEnum(val string) (ListingSubscriptionsSortByEnum, bool)

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

type ListingSubscriptionsSortOrderEnum

type ListingSubscriptionsSortOrderEnum string

ListingSubscriptionsSortOrderEnum Enum with underlying type: string

const (
	ListingSubscriptionsSortOrderAsc  ListingSubscriptionsSortOrderEnum = "ASC"
	ListingSubscriptionsSortOrderDesc ListingSubscriptionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListingSubscriptionsSortOrderEnum

func GetListingSubscriptionsSortOrderEnumValues

func GetListingSubscriptionsSortOrderEnumValues() []ListingSubscriptionsSortOrderEnum

GetListingSubscriptionsSortOrderEnumValues Enumerates the set of values for ListingSubscriptionsSortOrderEnum

func GetMappingListingSubscriptionsSortOrderEnum

func GetMappingListingSubscriptionsSortOrderEnum(val string) (ListingSubscriptionsSortOrderEnum, bool)

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

type Meter

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

Meter Details provide by seller for activation of its product.

func (Meter) String

func (m Meter) String() string

func (Meter) ValidateEnumValue

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

type MetricTypeEnum

type MetricTypeEnum string

MetricTypeEnum Enum with underlying type: string

const (
	MetricTypeOcpuHours     MetricTypeEnum = "OCPU_HOURS"
	MetricTypeInstanceHours MetricTypeEnum = "INSTANCE_HOURS"
	MetricTypeCoreHours     MetricTypeEnum = "CORE_HOURS"
)

Set of constants representing the allowable values for MetricTypeEnum

func GetMappingMetricTypeEnum

func GetMappingMetricTypeEnum(val string) (MetricTypeEnum, bool)

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

func GetMetricTypeEnumValues

func GetMetricTypeEnumValues() []MetricTypeEnum

GetMetricTypeEnumValues Enumerates the set of values for MetricTypeEnum

type OperationStatusEnum

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string

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

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string

const (
	OperationTypeCreateSubscription OperationTypeEnum = "CREATE_SUBSCRIPTION"
	OperationTypeUpdateSubscription OperationTypeEnum = "UPDATE_SUBSCRIPTION"
	OperationTypeDeleteSubscription OperationTypeEnum = "DELETE_SUBSCRIPTION"
	OperationTypeMoveSubscription   OperationTypeEnum = "MOVE_SUBSCRIPTION"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type PartnerIntegerationClient

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

PartnerIntegerationClient a client for PartnerIntegeration

func NewPartnerIntegerationClientWithConfigurationProvider

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

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 (PartnerIntegerationClient) ActivateSubscription

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.

See also

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

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

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

func (PartnerIntegerationClient) ListingSubscriptions

func (client PartnerIntegerationClient) ListingSubscriptions(ctx context.Context, request ListingSubscriptionsRequest) (response ListingSubscriptionsResponse, err error)

ListingSubscriptions Gets information about a Subscription.

See also

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 (PartnerIntegerationClient) ResolveSubscription

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.

See also

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 (*PartnerIntegerationClient) SetRegion

func (client *PartnerIntegerationClient) SetRegion(region string)

SetRegion overrides the region of this client.

type PartnerSubscription

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

PartnerSubscription These api for partner to communicate to OCI.

func (PartnerSubscription) String

func (m PartnerSubscription) String() string

func (PartnerSubscription) ValidateEnumValue

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

type PricingPlan

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

PricingPlan A pricing plan details provided by the Publisher.

func (PricingPlan) String

func (m PricingPlan) String() string

func (PricingPlan) ValidateEnumValue

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

type PricingPlanBillingFrequencyEnum

type PricingPlanBillingFrequencyEnum string

PricingPlanBillingFrequencyEnum Enum with underlying type: string

const (
	PricingPlanBillingFrequencyYearly PricingPlanBillingFrequencyEnum = "YEARLY"
)

Set of constants representing the allowable values for PricingPlanBillingFrequencyEnum

func GetMappingPricingPlanBillingFrequencyEnum

func GetMappingPricingPlanBillingFrequencyEnum(val string) (PricingPlanBillingFrequencyEnum, bool)

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

func GetPricingPlanBillingFrequencyEnumValues

func GetPricingPlanBillingFrequencyEnumValues() []PricingPlanBillingFrequencyEnum

GetPricingPlanBillingFrequencyEnumValues Enumerates the set of values for PricingPlanBillingFrequencyEnum

type PricingPlanPlanDurationEnum

type PricingPlanPlanDurationEnum string

PricingPlanPlanDurationEnum Enum with underlying type: string

const (
	PricingPlanPlanDurationAnnual PricingPlanPlanDurationEnum = "ANNUAL"
)

Set of constants representing the allowable values for PricingPlanPlanDurationEnum

func GetMappingPricingPlanPlanDurationEnum

func GetMappingPricingPlanPlanDurationEnum(val string) (PricingPlanPlanDurationEnum, bool)

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

func GetPricingPlanPlanDurationEnumValues

func GetPricingPlanPlanDurationEnumValues() []PricingPlanPlanDurationEnum

GetPricingPlanPlanDurationEnumValues Enumerates the set of values for PricingPlanPlanDurationEnum

type PricingPlanPlanTypeEnum

type PricingPlanPlanTypeEnum string

PricingPlanPlanTypeEnum Enum with underlying type: string

const (
	PricingPlanPlanTypeFixed PricingPlanPlanTypeEnum = "FIXED"
)

Set of constants representing the allowable values for PricingPlanPlanTypeEnum

func GetMappingPricingPlanPlanTypeEnum

func GetMappingPricingPlanPlanTypeEnum(val string) (PricingPlanPlanTypeEnum, bool)

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

func GetPricingPlanPlanTypeEnumValues

func GetPricingPlanPlanTypeEnumValues() []PricingPlanPlanTypeEnum

GetPricingPlanPlanTypeEnumValues Enumerates the set of values for PricingPlanPlanTypeEnum

type PricingRate

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

PricingRate A pricing plan rate provided by the Publisher.

func (PricingRate) String

func (m PricingRate) String() string

func (PricingRate) ValidateEnumValue

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

type ResolveSubscriptionDetails

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

ResolveSubscriptionDetails Request model used to resolve and retrieve subscription details for a customer subscription, given a selfToken and the productId.

func (ResolveSubscriptionDetails) String

func (ResolveSubscriptionDetails) ValidateEnumValue

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

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

ResolveSubscriptionRequest wrapper for the ResolveSubscription operation

See also

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.

func (ResolveSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ResolveSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ResolveSubscriptionRequest) RetryPolicy

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

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

func (ResolveSubscriptionRequest) String

func (request ResolveSubscriptionRequest) String() string

func (ResolveSubscriptionRequest) ValidateEnumValue

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

type ResolveSubscriptionResponse

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

ResolveSubscriptionResponse wrapper for the ResolveSubscription operation

func (ResolveSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ResolveSubscriptionResponse) String

func (response ResolveSubscriptionResponse) String() string

type SortOrderEnum

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type SourceTypeEnum

type SourceTypeEnum string

SourceTypeEnum Enum with underlying type: string

const (
	SourceTypeOciNative  SourceTypeEnum = "OCI_NATIVE"
	SourceTypeThirdParty SourceTypeEnum = "THIRD_PARTY"
)

Set of constants representing the allowable values for SourceTypeEnum

func GetMappingSourceTypeEnum

func GetMappingSourceTypeEnum(val string) (SourceTypeEnum, bool)

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

func GetSourceTypeEnumValues

func GetSourceTypeEnumValues() []SourceTypeEnum

GetSourceTypeEnumValues Enumerates the set of values for SourceTypeEnum

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

Subscription The model for a listing subscription.

func (Subscription) String

func (m Subscription) String() string

func (Subscription) ValidateEnumValue

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

type SubscriptionClient

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

SubscriptionClient a client for Subscription

func NewSubscriptionClientWithConfigurationProvider

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

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

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

CancelWorkRequest Cancels a work request.

See also

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 (SubscriptionClient) ChangeSubscriptionCompartment

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

See also

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

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

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

func (SubscriptionClient) CreateSubscription

func (client SubscriptionClient) CreateSubscription(ctx context.Context, request CreateSubscriptionRequest) (response CreateSubscriptionResponse, err error)

CreateSubscription Creates a Subscription.

See also

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 (SubscriptionClient) DeleteSubscription

func (client SubscriptionClient) DeleteSubscription(ctx context.Context, request DeleteSubscriptionRequest) (response DeleteSubscriptionResponse, err error)

DeleteSubscription Deletes a Subscription.

See also

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 (SubscriptionClient) GetSubscription

func (client SubscriptionClient) GetSubscription(ctx context.Context, request GetSubscriptionRequest) (response GetSubscriptionResponse, err error)

GetSubscription Gets information about a Subscription.

See also

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 (SubscriptionClient) GetSubscriptionToken

func (client SubscriptionClient) GetSubscriptionToken(ctx context.Context, request GetSubscriptionTokenRequest) (response GetSubscriptionTokenResponse, err error)

GetSubscriptionToken Gets a token of Subscriptions.

See also

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 (SubscriptionClient) GetWorkRequest

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

GetWorkRequest Gets the details of a work request.

See also

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 (SubscriptionClient) ListSubscriptions

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.

See also

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 (SubscriptionClient) ListWorkRequestErrors

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

ListWorkRequestErrors Lists the errors for a work request.

See also

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 (SubscriptionClient) ListWorkRequestLogs

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

ListWorkRequestLogs Lists the logs for a work request.

See also

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 (SubscriptionClient) ListWorkRequests

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

ListWorkRequests Lists the work requests in a compartment.

See also

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 (*SubscriptionClient) SetRegion

func (client *SubscriptionClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (SubscriptionClient) UpdateSubscription

func (client SubscriptionClient) UpdateSubscription(ctx context.Context, request UpdateSubscriptionRequest) (response UpdateSubscriptionResponse, err error)

UpdateSubscription Updates a Subscription.

See also

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

type SubscriptionCollection

type SubscriptionCollection struct {

	// List of subscriptions.
	Items []SubscriptionSummary `mandatory:"true" json:"items"`
}

SubscriptionCollection Results of a subscription search. Contains both SubscriptionSummary items and other information, such as metadata.

func (SubscriptionCollection) String

func (m SubscriptionCollection) String() string

func (SubscriptionCollection) ValidateEnumValue

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

type SubscriptionDetails

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

SubscriptionDetails The details of a subscription

func (SubscriptionDetails) String

func (m SubscriptionDetails) String() string

func (SubscriptionDetails) ValidateEnumValue

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

type SubscriptionSummary

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

SubscriptionSummary The model for a summary of a subscription.

func (SubscriptionSummary) String

func (m SubscriptionSummary) String() string

func (SubscriptionSummary) ValidateEnumValue

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

type SubscriptionToken

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

SubscriptionToken The base 64 encoded JWT token which is mapped to a particular subscription.

func (SubscriptionToken) String

func (m SubscriptionToken) String() string

func (SubscriptionToken) ValidateEnumValue

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

type UpdateSubscriptionDetails

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

UpdateSubscriptionDetails The data to update a Subscription.

func (UpdateSubscriptionDetails) String

func (m UpdateSubscriptionDetails) String() string

func (UpdateSubscriptionDetails) ValidateEnumValue

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

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

UpdateSubscriptionRequest wrapper for the UpdateSubscription operation

See also

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.

func (UpdateSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateSubscriptionRequest) RetryPolicy

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

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

func (UpdateSubscriptionRequest) String

func (request UpdateSubscriptionRequest) String() string

func (UpdateSubscriptionRequest) ValidateEnumValue

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

type UpdateSubscriptionResponse

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

UpdateSubscriptionResponse wrapper for the UpdateSubscription operation

func (UpdateSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateSubscriptionResponse) String

func (response UpdateSubscriptionResponse) String() string

type WorkRequest

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

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.

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

func (m WorkRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestError

type WorkRequestError struct {

	// A machine-usable code for the error that 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"`
}

WorkRequestError An error encountered while performing an operation that is tracked by a work request.

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

func (m WorkRequestError) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestErrorCollection

type WorkRequestErrorCollection struct {

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

WorkRequestErrorCollection A list of work request errors. Can contain both errors and other information, such as metadata.

func (WorkRequestErrorCollection) String

func (WorkRequestErrorCollection) ValidateEnumValue

func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestLogEntry

type WorkRequestLogEntry struct {

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

WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestLogEntryCollection

type WorkRequestLogEntryCollection struct {

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

WorkRequestLogEntryCollection A list of work request logs. Can contain both logs and other information, such as metadata.

func (WorkRequestLogEntryCollection) String

func (WorkRequestLogEntryCollection) ValidateEnumValue

func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestResource

type WorkRequestResource struct {

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

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

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

func (m WorkRequestResource) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestResourceMetadataKeyEnum

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string

const (
	WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

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

func GetWorkRequestResourceMetadataKeyEnumValues

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSummary

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

WorkRequestSummary Summary information about an asynchronous work request.

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

func (m WorkRequestSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestSummaryCollection

type WorkRequestSummaryCollection struct {

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

WorkRequestSummaryCollection A list of work requests. Can contain both work requests and other information, such as metadata.

func (WorkRequestSummaryCollection) String

func (WorkRequestSummaryCollection) ValidateEnumValue

func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL