func GetCreateOceInstanceDetailsInstanceAccessTypeEnumStringValues() []string
GetCreateOceInstanceDetailsInstanceAccessTypeEnumStringValues Enumerates the set of values in String for CreateOceInstanceDetailsInstanceAccessTypeEnum
func GetCreateOceInstanceDetailsInstanceUsageTypeEnumStringValues() []string
GetCreateOceInstanceDetailsInstanceUsageTypeEnumStringValues Enumerates the set of values in String for CreateOceInstanceDetailsInstanceUsageTypeEnum
func GetLicenseTypeEnumStringValues() []string
GetLicenseTypeEnumStringValues Enumerates the set of values in String for LicenseTypeEnum
func GetLifecycleDetailsEnumStringValues() []string
GetLifecycleDetailsEnumStringValues Enumerates the set of values in String for LifecycleDetailsEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetListOceInstancesLifecycleStateEnumStringValues() []string
GetListOceInstancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListOceInstancesLifecycleStateEnum
func GetListOceInstancesSortByEnumStringValues() []string
GetListOceInstancesSortByEnumStringValues Enumerates the set of values in String for ListOceInstancesSortByEnum
func GetListOceInstancesSortOrderEnumStringValues() []string
GetListOceInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListOceInstancesSortOrderEnum
func GetOceInstanceInstanceAccessTypeEnumStringValues() []string
GetOceInstanceInstanceAccessTypeEnumStringValues Enumerates the set of values in String for OceInstanceInstanceAccessTypeEnum
func GetOceInstanceInstanceUsageTypeEnumStringValues() []string
GetOceInstanceInstanceUsageTypeEnumStringValues Enumerates the set of values in String for OceInstanceInstanceUsageTypeEnum
func GetOceInstanceSummaryInstanceAccessTypeEnumStringValues() []string
GetOceInstanceSummaryInstanceAccessTypeEnumStringValues Enumerates the set of values in String for OceInstanceSummaryInstanceAccessTypeEnum
func GetOceInstanceSummaryInstanceUsageTypeEnumStringValues() []string
GetOceInstanceSummaryInstanceUsageTypeEnumStringValues Enumerates the set of values in String for OceInstanceSummaryInstanceUsageTypeEnum
func GetOceInstanceUpgradeScheduleEnumStringValues() []string
GetOceInstanceUpgradeScheduleEnumStringValues Enumerates the set of values in String for OceInstanceUpgradeScheduleEnum
func GetUpdateOceInstanceDetailsInstanceUsageTypeEnumStringValues() []string
GetUpdateOceInstanceDetailsInstanceUsageTypeEnumStringValues Enumerates the set of values in String for UpdateOceInstanceDetailsInstanceUsageTypeEnum
func GetWorkRequestOperationTypeEnumStringValues() []string
GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum
func GetWorkRequestResourceActionTypeEnumStringValues() []string
GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum
func GetWorkRequestStatusEnumStringValues() []string
GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum
ChangeOceInstanceCompartmentDetails The information about compartment details.
type ChangeOceInstanceCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
// into which the OceInstance should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeOceInstanceCompartmentDetails) String() string
func (m ChangeOceInstanceCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeOceInstanceCompartmentRequest wrapper for the ChangeOceInstanceCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/ChangeOceInstanceCompartment.go.html to see an example of how to use ChangeOceInstanceCompartmentRequest.
type ChangeOceInstanceCompartmentRequest struct {
// unique OceInstance identifier
OceInstanceId *string `mandatory:"true" contributesTo:"path" name:"oceInstanceId"`
// The information about compartment details to be moved.
ChangeOceInstanceCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeOceInstanceCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeOceInstanceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeOceInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeOceInstanceCompartmentRequest) String() string
func (request ChangeOceInstanceCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeOceInstanceCompartmentResponse wrapper for the ChangeOceInstanceCompartment operation
type ChangeOceInstanceCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeOceInstanceCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeOceInstanceCompartmentResponse) String() string
CreateOceInstanceDetails The information about new OceInstance.
type CreateOceInstanceDetails struct {
// Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// OceInstance Name
Name *string `mandatory:"true" json:"name"`
// Tenancy Identifier
TenancyId *string `mandatory:"true" json:"tenancyId"`
// Identity Cloud Service access token identifying a stripe and service administrator user
IdcsAccessToken *string `mandatory:"true" json:"idcsAccessToken"`
// Tenancy Name
TenancyName *string `mandatory:"true" json:"tenancyName"`
// Object Storage Namespace of Tenancy
ObjectStorageNamespace *string `mandatory:"true" json:"objectStorageNamespace"`
// Admin Email for Notification
AdminEmail *string `mandatory:"true" json:"adminEmail"`
// OceInstance description
Description *string `mandatory:"false" json:"description"`
IdentityStripe *IdentityStripeDetails `mandatory:"false" json:"identityStripe"`
// Instance type based on its usage
InstanceUsageType CreateOceInstanceDetailsInstanceUsageTypeEnum `mandatory:"false" json:"instanceUsageType,omitempty"`
// a list of add-on features for the ocm instance
AddOnFeatures []string `mandatory:"false" json:"addOnFeatures"`
// Upgrade schedule type representing service to be upgraded immediately whenever latest version is released
// or delay upgrade of the service to previous released version
UpgradeSchedule OceInstanceUpgradeScheduleEnum `mandatory:"false" json:"upgradeSchedule,omitempty"`
// Web Application Firewall(WAF) primary domain
WafPrimaryDomain *string `mandatory:"false" json:"wafPrimaryDomain"`
// Flag indicating whether the instance access is private or public
InstanceAccessType CreateOceInstanceDetailsInstanceAccessTypeEnum `mandatory:"false" json:"instanceAccessType,omitempty"`
// Flag indicating whether the instance license is new cloud or bring your own license
InstanceLicenseType LicenseTypeEnum `mandatory:"false" json:"instanceLicenseType,omitempty"`
// disaster recovery paired ragion name
DrRegion *string `mandatory:"false" json:"drRegion"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateOceInstanceDetails) String() string
func (m CreateOceInstanceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateOceInstanceDetailsInstanceAccessTypeEnum Enum with underlying type: string
type CreateOceInstanceDetailsInstanceAccessTypeEnum string
Set of constants representing the allowable values for CreateOceInstanceDetailsInstanceAccessTypeEnum
const (
CreateOceInstanceDetailsInstanceAccessTypePublic CreateOceInstanceDetailsInstanceAccessTypeEnum = "PUBLIC"
CreateOceInstanceDetailsInstanceAccessTypePrivate CreateOceInstanceDetailsInstanceAccessTypeEnum = "PRIVATE"
)
func GetCreateOceInstanceDetailsInstanceAccessTypeEnumValues() []CreateOceInstanceDetailsInstanceAccessTypeEnum
GetCreateOceInstanceDetailsInstanceAccessTypeEnumValues Enumerates the set of values for CreateOceInstanceDetailsInstanceAccessTypeEnum
func GetMappingCreateOceInstanceDetailsInstanceAccessTypeEnum(val string) (CreateOceInstanceDetailsInstanceAccessTypeEnum, bool)
GetMappingCreateOceInstanceDetailsInstanceAccessTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateOceInstanceDetailsInstanceUsageTypeEnum Enum with underlying type: string
type CreateOceInstanceDetailsInstanceUsageTypeEnum string
Set of constants representing the allowable values for CreateOceInstanceDetailsInstanceUsageTypeEnum
const (
CreateOceInstanceDetailsInstanceUsageTypePrimary CreateOceInstanceDetailsInstanceUsageTypeEnum = "PRIMARY"
CreateOceInstanceDetailsInstanceUsageTypeNonprimary CreateOceInstanceDetailsInstanceUsageTypeEnum = "NONPRIMARY"
)
func GetCreateOceInstanceDetailsInstanceUsageTypeEnumValues() []CreateOceInstanceDetailsInstanceUsageTypeEnum
GetCreateOceInstanceDetailsInstanceUsageTypeEnumValues Enumerates the set of values for CreateOceInstanceDetailsInstanceUsageTypeEnum
func GetMappingCreateOceInstanceDetailsInstanceUsageTypeEnum(val string) (CreateOceInstanceDetailsInstanceUsageTypeEnum, bool)
GetMappingCreateOceInstanceDetailsInstanceUsageTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateOceInstanceRequest wrapper for the CreateOceInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/CreateOceInstance.go.html to see an example of how to use CreateOceInstanceRequest.
type CreateOceInstanceRequest struct {
// Details for the new OceInstance.
CreateOceInstanceDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateOceInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOceInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOceInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOceInstanceRequest) String() string
func (request CreateOceInstanceRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateOceInstanceResponse wrapper for the CreateOceInstance operation
type CreateOceInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateOceInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOceInstanceResponse) String() string
DeleteOceInstanceRequest wrapper for the DeleteOceInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/DeleteOceInstance.go.html to see an example of how to use DeleteOceInstanceRequest.
type DeleteOceInstanceRequest struct {
// unique OceInstance identifier
OceInstanceId *string `mandatory:"true" contributesTo:"path" name:"oceInstanceId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteOceInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOceInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOceInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOceInstanceRequest) String() string
func (request DeleteOceInstanceRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteOceInstanceResponse wrapper for the DeleteOceInstance operation
type DeleteOceInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteOceInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOceInstanceResponse) String() string
GetOceInstanceRequest wrapper for the GetOceInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/GetOceInstance.go.html to see an example of how to use GetOceInstanceRequest.
type GetOceInstanceRequest struct {
// unique OceInstance identifier
OceInstanceId *string `mandatory:"true" contributesTo:"path" name:"oceInstanceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetOceInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOceInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOceInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOceInstanceRequest) String() string
func (request GetOceInstanceRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetOceInstanceResponse wrapper for the GetOceInstance operation
type GetOceInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The OceInstance instance
OceInstance `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetOceInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOceInstanceResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// some decimal number representing the number of seconds the client should wait before polling this endpoint again
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
IdentityStripeDetails Details of the identity stripe used for OceInstance
type IdentityStripeDetails struct {
// Name of the Identity Cloud Service instance in My Services to be used.
// Example: `secondstripe`
ServiceName *string `mandatory:"true" json:"serviceName"`
// Value of the Identity Cloud Service tenancy.
// Example: `idcs-8416ebdd0d674f84803f4193cce026e9`
Tenancy *string `mandatory:"true" json:"tenancy"`
}
func (m IdentityStripeDetails) String() string
func (m IdentityStripeDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
LicenseTypeEnum Enum with underlying type: string
type LicenseTypeEnum string
Set of constants representing the allowable values for LicenseTypeEnum
const (
LicenseTypeNew LicenseTypeEnum = "NEW"
LicenseTypeByol LicenseTypeEnum = "BYOL"
LicenseTypePremium LicenseTypeEnum = "PREMIUM"
LicenseTypeStarter LicenseTypeEnum = "STARTER"
)
func GetLicenseTypeEnumValues() []LicenseTypeEnum
GetLicenseTypeEnumValues Enumerates the set of values for LicenseTypeEnum
func GetMappingLicenseTypeEnum(val string) (LicenseTypeEnum, bool)
GetMappingLicenseTypeEnum performs case Insensitive comparison on enum value and return the desired enum
LifecycleDetailsEnum Enum with underlying type: string
type LifecycleDetailsEnum string
Set of constants representing the allowable values for LifecycleDetailsEnum
const (
LifecycleDetailsStandby LifecycleDetailsEnum = "STANDBY"
LifecycleDetailsFailover LifecycleDetailsEnum = "FAILOVER"
LifecycleDetailsDown LifecycleDetailsEnum = "DOWN"
LifecycleDetailsPrimary LifecycleDetailsEnum = "PRIMARY"
)
func GetLifecycleDetailsEnumValues() []LifecycleDetailsEnum
GetLifecycleDetailsEnumValues Enumerates the set of values for LifecycleDetailsEnum
func GetMappingLifecycleDetailsEnum(val string) (LifecycleDetailsEnum, bool)
GetMappingLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum
const (
LifecycleStateCreating LifecycleStateEnum = "CREATING"
LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateDeleting LifecycleStateEnum = "DELETING"
LifecycleStateDeleted LifecycleStateEnum = "DELETED"
LifecycleStateFailed LifecycleStateEnum = "FAILED"
)
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListOceInstancesLifecycleStateEnum Enum with underlying type: string
type ListOceInstancesLifecycleStateEnum string
Set of constants representing the allowable values for ListOceInstancesLifecycleStateEnum
const (
ListOceInstancesLifecycleStateCreating ListOceInstancesLifecycleStateEnum = "CREATING"
ListOceInstancesLifecycleStateUpdating ListOceInstancesLifecycleStateEnum = "UPDATING"
ListOceInstancesLifecycleStateActive ListOceInstancesLifecycleStateEnum = "ACTIVE"
ListOceInstancesLifecycleStateDeleting ListOceInstancesLifecycleStateEnum = "DELETING"
ListOceInstancesLifecycleStateDeleted ListOceInstancesLifecycleStateEnum = "DELETED"
ListOceInstancesLifecycleStateFailed ListOceInstancesLifecycleStateEnum = "FAILED"
)
func GetListOceInstancesLifecycleStateEnumValues() []ListOceInstancesLifecycleStateEnum
GetListOceInstancesLifecycleStateEnumValues Enumerates the set of values for ListOceInstancesLifecycleStateEnum
func GetMappingListOceInstancesLifecycleStateEnum(val string) (ListOceInstancesLifecycleStateEnum, bool)
GetMappingListOceInstancesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListOceInstancesRequest wrapper for the ListOceInstances operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/ListOceInstances.go.html to see an example of how to use ListOceInstancesRequest.
type ListOceInstancesRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The ID of the tenancy in which to list resources.
TenancyId *string `mandatory:"false" contributesTo:"query" name:"tenancyId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListOceInstancesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
SortBy ListOceInstancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Filter results on lifecycleState.
LifecycleState ListOceInstancesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListOceInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOceInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOceInstancesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOceInstancesRequest) String() string
func (request ListOceInstancesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListOceInstancesResponse wrapper for the ListOceInstances operation
type ListOceInstancesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []OceInstanceSummary instances
Items []OceInstanceSummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of `OceInstance`s. If this header appears in the response, then this
// is a partial list of OceInstances. Include this value as the `page` parameter in a subsequent
// GET request to get the next batch of OceInstances.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListOceInstancesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOceInstancesResponse) String() string
ListOceInstancesSortByEnum Enum with underlying type: string
type ListOceInstancesSortByEnum string
Set of constants representing the allowable values for ListOceInstancesSortByEnum
const (
ListOceInstancesSortByTimecreated ListOceInstancesSortByEnum = "timeCreated"
ListOceInstancesSortByDisplayname ListOceInstancesSortByEnum = "displayName"
)
func GetListOceInstancesSortByEnumValues() []ListOceInstancesSortByEnum
GetListOceInstancesSortByEnumValues Enumerates the set of values for ListOceInstancesSortByEnum
func GetMappingListOceInstancesSortByEnum(val string) (ListOceInstancesSortByEnum, bool)
GetMappingListOceInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOceInstancesSortOrderEnum Enum with underlying type: string
type ListOceInstancesSortOrderEnum string
Set of constants representing the allowable values for ListOceInstancesSortOrderEnum
const (
ListOceInstancesSortOrderAsc ListOceInstancesSortOrderEnum = "ASC"
ListOceInstancesSortOrderDesc ListOceInstancesSortOrderEnum = "DESC"
)
func GetListOceInstancesSortOrderEnumValues() []ListOceInstancesSortOrderEnum
GetListOceInstancesSortOrderEnumValues Enumerates the set of values for ListOceInstancesSortOrderEnum
func GetMappingListOceInstancesSortOrderEnum(val string) (ListOceInstancesSortOrderEnum, bool)
GetMappingListOceInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestError instances
Items []WorkRequestError `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the `page` parameter for the
// subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestLogEntry instances
Items []WorkRequestLogEntry `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the `page` parameter for the
// subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The resource Identifier for which to list resources.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequest instances
Items []WorkRequest `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
OceInstance Details of OceInstance.
type OceInstance struct {
// Unique identifier that is immutable on creation
Id *string `mandatory:"true" json:"id"`
// Unique GUID identifier that is immutable on creation
Guid *string `mandatory:"true" json:"guid"`
// Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// OceInstance Name
Name *string `mandatory:"true" json:"name"`
// Tenancy Identifier
TenancyId *string `mandatory:"true" json:"tenancyId"`
// IDCS Tenancy Identifier
IdcsTenancy *string `mandatory:"true" json:"idcsTenancy"`
// Tenancy Name
TenancyName *string `mandatory:"true" json:"tenancyName"`
// Object Storage Namespace of tenancy
ObjectStorageNamespace *string `mandatory:"true" json:"objectStorageNamespace"`
// Admin Email for Notification
AdminEmail *string `mandatory:"true" json:"adminEmail"`
// OceInstance description, can be updated
Description *string `mandatory:"false" json:"description"`
// Upgrade schedule type representing service to be upgraded immediately whenever latest version is released
// or delay upgrade of the service to previous released version
UpgradeSchedule OceInstanceUpgradeScheduleEnum `mandatory:"false" json:"upgradeSchedule,omitempty"`
IdentityStripe *IdentityStripeDetails `mandatory:"false" json:"identityStripe"`
// Instance type based on its usage
InstanceUsageType OceInstanceInstanceUsageTypeEnum `mandatory:"false" json:"instanceUsageType,omitempty"`
// a list of add-on features for the ocm instance
AddOnFeatures []string `mandatory:"false" json:"addOnFeatures"`
// Web Application Firewall(WAF) primary domain
WafPrimaryDomain *string `mandatory:"false" json:"wafPrimaryDomain"`
// Flag indicating whether the instance access is private or public
InstanceAccessType OceInstanceInstanceAccessTypeEnum `mandatory:"false" json:"instanceAccessType,omitempty"`
// Flag indicating whether the instance license is new cloud or bring your own license
InstanceLicenseType LicenseTypeEnum `mandatory:"false" json:"instanceLicenseType,omitempty"`
// The time the the OceInstance was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the OceInstance was updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the instance lifecycle.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Details of the current state of the instance lifecycle
LifecycleDetails LifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
// disaster recovery paired ragion name
DrRegion *string `mandatory:"false" json:"drRegion"`
// An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
StateMessage *string `mandatory:"false" json:"stateMessage"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// SERVICE data.
// Example: `{"service": {"IDCS": "value"}}`
Service map[string]interface{} `mandatory:"false" json:"service"`
}
func (m OceInstance) String() string
func (m OceInstance) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OceInstanceClient a client for OceInstance
type OceInstanceClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewOceInstanceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OceInstanceClient, err error)
NewOceInstanceClientWithConfigurationProvider Creates a new default OceInstance client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewOceInstanceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OceInstanceClient, err error)
NewOceInstanceClientWithOboToken Creates a new default OceInstance client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client OceInstanceClient) ChangeOceInstanceCompartment(ctx context.Context, request ChangeOceInstanceCompartmentRequest) (response ChangeOceInstanceCompartmentResponse, err error)
ChangeOceInstanceCompartment Moves a OceInstance into a different compartment
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/ChangeOceInstanceCompartment.go.html to see an example of how to use ChangeOceInstanceCompartment API. A default retry strategy applies to this operation ChangeOceInstanceCompartment()
func (client *OceInstanceClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client OceInstanceClient) CreateOceInstance(ctx context.Context, request CreateOceInstanceRequest) (response CreateOceInstanceResponse, err error)
CreateOceInstance Creates a new OceInstance.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/CreateOceInstance.go.html to see an example of how to use CreateOceInstance API. A default retry strategy applies to this operation CreateOceInstance()
func (client OceInstanceClient) DeleteOceInstance(ctx context.Context, request DeleteOceInstanceRequest) (response DeleteOceInstanceResponse, err error)
DeleteOceInstance Deletes a OceInstance resource by identifier
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/DeleteOceInstance.go.html to see an example of how to use DeleteOceInstance API. A default retry strategy applies to this operation DeleteOceInstance()
func (client OceInstanceClient) GetOceInstance(ctx context.Context, request GetOceInstanceRequest) (response GetOceInstanceResponse, err error)
GetOceInstance Gets a OceInstance by identifier
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/GetOceInstance.go.html to see an example of how to use GetOceInstance API. A default retry strategy applies to this operation GetOceInstance()
func (client OceInstanceClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client OceInstanceClient) ListOceInstances(ctx context.Context, request ListOceInstancesRequest) (response ListOceInstancesResponse, err error)
ListOceInstances Returns a list of OceInstances.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/ListOceInstances.go.html to see an example of how to use ListOceInstances API. A default retry strategy applies to this operation ListOceInstances()
func (client OceInstanceClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Return a (paginated) list of errors for a given work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client OceInstanceClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Return a (paginated) list of logs for a given work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client OceInstanceClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *OceInstanceClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client OceInstanceClient) UpdateOceInstance(ctx context.Context, request UpdateOceInstanceRequest) (response UpdateOceInstanceResponse, err error)
UpdateOceInstance Updates the OceInstance
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/UpdateOceInstance.go.html to see an example of how to use UpdateOceInstance API. A default retry strategy applies to this operation UpdateOceInstance()
OceInstanceInstanceAccessTypeEnum Enum with underlying type: string
type OceInstanceInstanceAccessTypeEnum string
Set of constants representing the allowable values for OceInstanceInstanceAccessTypeEnum
const (
OceInstanceInstanceAccessTypePublic OceInstanceInstanceAccessTypeEnum = "PUBLIC"
OceInstanceInstanceAccessTypePrivate OceInstanceInstanceAccessTypeEnum = "PRIVATE"
)
func GetMappingOceInstanceInstanceAccessTypeEnum(val string) (OceInstanceInstanceAccessTypeEnum, bool)
GetMappingOceInstanceInstanceAccessTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOceInstanceInstanceAccessTypeEnumValues() []OceInstanceInstanceAccessTypeEnum
GetOceInstanceInstanceAccessTypeEnumValues Enumerates the set of values for OceInstanceInstanceAccessTypeEnum
OceInstanceInstanceUsageTypeEnum Enum with underlying type: string
type OceInstanceInstanceUsageTypeEnum string
Set of constants representing the allowable values for OceInstanceInstanceUsageTypeEnum
const (
OceInstanceInstanceUsageTypePrimary OceInstanceInstanceUsageTypeEnum = "PRIMARY"
OceInstanceInstanceUsageTypeNonprimary OceInstanceInstanceUsageTypeEnum = "NONPRIMARY"
)
func GetMappingOceInstanceInstanceUsageTypeEnum(val string) (OceInstanceInstanceUsageTypeEnum, bool)
GetMappingOceInstanceInstanceUsageTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOceInstanceInstanceUsageTypeEnumValues() []OceInstanceInstanceUsageTypeEnum
GetOceInstanceInstanceUsageTypeEnumValues Enumerates the set of values for OceInstanceInstanceUsageTypeEnum
OceInstanceSummary Summary of the OceInstance.
type OceInstanceSummary struct {
// Unique identifier that is immutable on creation
Id *string `mandatory:"true" json:"id"`
// Unique GUID identifier that is immutable on creation
Guid *string `mandatory:"true" json:"guid"`
// Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// OceInstance Name
Name *string `mandatory:"true" json:"name"`
// Tenancy Identifier
TenancyId *string `mandatory:"true" json:"tenancyId"`
// IDCS Tenancy Identifier
IdcsTenancy *string `mandatory:"true" json:"idcsTenancy"`
// Tenancy Name
TenancyName *string `mandatory:"true" json:"tenancyName"`
// Object Storage Namespace of tenancy
ObjectStorageNamespace *string `mandatory:"true" json:"objectStorageNamespace"`
// Admin Email for Notification
AdminEmail *string `mandatory:"true" json:"adminEmail"`
// OceInstance description, can be updated
Description *string `mandatory:"false" json:"description"`
// Instance type based on its usage
InstanceUsageType OceInstanceSummaryInstanceUsageTypeEnum `mandatory:"false" json:"instanceUsageType,omitempty"`
// a list of add-on features for the ocm instance
AddOnFeatures []string `mandatory:"false" json:"addOnFeatures"`
// Upgrade schedule type representing service to be upgraded immediately whenever latest version is released
// or delay upgrade of the service to previous released version
UpgradeSchedule OceInstanceUpgradeScheduleEnum `mandatory:"false" json:"upgradeSchedule,omitempty"`
// Web Application Firewall(WAF) primary domain
WafPrimaryDomain *string `mandatory:"false" json:"wafPrimaryDomain"`
// Flag indicating whether the instance access is private or public
InstanceAccessType OceInstanceSummaryInstanceAccessTypeEnum `mandatory:"false" json:"instanceAccessType,omitempty"`
// Flag indicating whether the instance license is new cloud or bring your own license
InstanceLicenseType LicenseTypeEnum `mandatory:"false" json:"instanceLicenseType,omitempty"`
// The time the the OceInstance was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the OceInstance was updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the instance lifecycle.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Details of the current state of the instance lifecycle
LifecycleDetails LifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
// disaster recovery paired ragion name
DrRegion *string `mandatory:"false" json:"drRegion"`
// An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
StateMessage *string `mandatory:"false" json:"stateMessage"`
// SERVICE data.
// Example: `{"service": {"IDCS": "value"}}`
Service map[string]interface{} `mandatory:"false" json:"service"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m OceInstanceSummary) String() string
func (m OceInstanceSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OceInstanceSummaryInstanceAccessTypeEnum Enum with underlying type: string
type OceInstanceSummaryInstanceAccessTypeEnum string
Set of constants representing the allowable values for OceInstanceSummaryInstanceAccessTypeEnum
const (
OceInstanceSummaryInstanceAccessTypePublic OceInstanceSummaryInstanceAccessTypeEnum = "PUBLIC"
OceInstanceSummaryInstanceAccessTypePrivate OceInstanceSummaryInstanceAccessTypeEnum = "PRIVATE"
)
func GetMappingOceInstanceSummaryInstanceAccessTypeEnum(val string) (OceInstanceSummaryInstanceAccessTypeEnum, bool)
GetMappingOceInstanceSummaryInstanceAccessTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOceInstanceSummaryInstanceAccessTypeEnumValues() []OceInstanceSummaryInstanceAccessTypeEnum
GetOceInstanceSummaryInstanceAccessTypeEnumValues Enumerates the set of values for OceInstanceSummaryInstanceAccessTypeEnum
OceInstanceSummaryInstanceUsageTypeEnum Enum with underlying type: string
type OceInstanceSummaryInstanceUsageTypeEnum string
Set of constants representing the allowable values for OceInstanceSummaryInstanceUsageTypeEnum
const (
OceInstanceSummaryInstanceUsageTypePrimary OceInstanceSummaryInstanceUsageTypeEnum = "PRIMARY"
OceInstanceSummaryInstanceUsageTypeNonprimary OceInstanceSummaryInstanceUsageTypeEnum = "NONPRIMARY"
)
func GetMappingOceInstanceSummaryInstanceUsageTypeEnum(val string) (OceInstanceSummaryInstanceUsageTypeEnum, bool)
GetMappingOceInstanceSummaryInstanceUsageTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOceInstanceSummaryInstanceUsageTypeEnumValues() []OceInstanceSummaryInstanceUsageTypeEnum
GetOceInstanceSummaryInstanceUsageTypeEnumValues Enumerates the set of values for OceInstanceSummaryInstanceUsageTypeEnum
OceInstanceUpgradeScheduleEnum Enum with underlying type: string
type OceInstanceUpgradeScheduleEnum string
Set of constants representing the allowable values for OceInstanceUpgradeScheduleEnum
const (
OceInstanceUpgradeScheduleUpgradeImmediately OceInstanceUpgradeScheduleEnum = "UPGRADE_IMMEDIATELY"
OceInstanceUpgradeScheduleDelayedUpgrade OceInstanceUpgradeScheduleEnum = "DELAYED_UPGRADE"
)
func GetMappingOceInstanceUpgradeScheduleEnum(val string) (OceInstanceUpgradeScheduleEnum, bool)
GetMappingOceInstanceUpgradeScheduleEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOceInstanceUpgradeScheduleEnumValues() []OceInstanceUpgradeScheduleEnum
GetOceInstanceUpgradeScheduleEnumValues Enumerates the set of values for OceInstanceUpgradeScheduleEnum
UpdateOceInstanceDetails The information to be updated.
type UpdateOceInstanceDetails struct {
// OceInstance description
Description *string `mandatory:"false" json:"description"`
// Web Application Firewall(WAF) primary domain
WafPrimaryDomain *string `mandatory:"false" json:"wafPrimaryDomain"`
// Flag indicating whether the instance license is new cloud or bring your own license
InstanceLicenseType LicenseTypeEnum `mandatory:"false" json:"instanceLicenseType,omitempty"`
// Instance type based on its usage
InstanceUsageType UpdateOceInstanceDetailsInstanceUsageTypeEnum `mandatory:"false" json:"instanceUsageType,omitempty"`
// a list of add-on features for the ocm instance
AddOnFeatures []string `mandatory:"false" json:"addOnFeatures"`
// Details of the current state of the instance lifecycle
LifecycleDetails LifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
// disaster recovery paired ragion name
DrRegion *string `mandatory:"false" json:"drRegion"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateOceInstanceDetails) String() string
func (m UpdateOceInstanceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateOceInstanceDetailsInstanceUsageTypeEnum Enum with underlying type: string
type UpdateOceInstanceDetailsInstanceUsageTypeEnum string
Set of constants representing the allowable values for UpdateOceInstanceDetailsInstanceUsageTypeEnum
const (
UpdateOceInstanceDetailsInstanceUsageTypePrimary UpdateOceInstanceDetailsInstanceUsageTypeEnum = "PRIMARY"
UpdateOceInstanceDetailsInstanceUsageTypeNonprimary UpdateOceInstanceDetailsInstanceUsageTypeEnum = "NONPRIMARY"
)
func GetMappingUpdateOceInstanceDetailsInstanceUsageTypeEnum(val string) (UpdateOceInstanceDetailsInstanceUsageTypeEnum, bool)
GetMappingUpdateOceInstanceDetailsInstanceUsageTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateOceInstanceDetailsInstanceUsageTypeEnumValues() []UpdateOceInstanceDetailsInstanceUsageTypeEnum
GetUpdateOceInstanceDetailsInstanceUsageTypeEnumValues Enumerates the set of values for UpdateOceInstanceDetailsInstanceUsageTypeEnum
UpdateOceInstanceRequest wrapper for the UpdateOceInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/oce/UpdateOceInstance.go.html to see an example of how to use UpdateOceInstanceRequest.
type UpdateOceInstanceRequest struct {
// unique OceInstance identifier
OceInstanceId *string `mandatory:"true" contributesTo:"path" name:"oceInstanceId"`
// The information to be updated.
UpdateOceInstanceDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateOceInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateOceInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOceInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOceInstanceRequest) String() string
func (request UpdateOceInstanceRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateOceInstanceResponse wrapper for the UpdateOceInstance operation
type UpdateOceInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateOceInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOceInstanceResponse) String() string
WorkRequest A description of workrequest status
type WorkRequest struct {
// type of the work request
OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`
// status of current work request.
Status WorkRequestStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
WorkflowMonitor *WorkflowMonitor `mandatory:"false" json:"workflowMonitor"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed on
// (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestOperationTypeEnum Enum with underlying type: string
type WorkRequestOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestOperationTypeEnum
const (
WorkRequestOperationTypeCreateOceInstance WorkRequestOperationTypeEnum = "CREATE_OCE_INSTANCE"
WorkRequestOperationTypeUpdateOceInstance WorkRequestOperationTypeEnum = "UPDATE_OCE_INSTANCE"
WorkRequestOperationTypeDeleteOceInstance WorkRequestOperationTypeEnum = "DELETE_OCE_INSTANCE"
)
func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)
GetMappingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request is affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType WorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResourceActionTypeEnum Enum with underlying type: string
type WorkRequestResourceActionTypeEnum string
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum
const (
WorkRequestResourceActionTypeCreated WorkRequestResourceActionTypeEnum = "CREATED"
WorkRequestResourceActionTypeUpdated WorkRequestResourceActionTypeEnum = "UPDATED"
WorkRequestResourceActionTypeDeleted WorkRequestResourceActionTypeEnum = "DELETED"
WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
WorkRequestResourceActionTypeFailed WorkRequestResourceActionTypeEnum = "FAILED"
)
func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)
GetMappingWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum
WorkRequestStatusEnum Enum with underlying type: string
type WorkRequestStatusEnum string
Set of constants representing the allowable values for WorkRequestStatusEnum
const (
WorkRequestStatusAccepted WorkRequestStatusEnum = "ACCEPTED"
WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
WorkRequestStatusFailed WorkRequestStatusEnum = "FAILED"
WorkRequestStatusSucceeded WorkRequestStatusEnum = "SUCCEEDED"
WorkRequestStatusCanceling WorkRequestStatusEnum = "CANCELING"
WorkRequestStatusCanceled WorkRequestStatusEnum = "CANCELED"
)
func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)
GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum
WorkflowMonitor The workflow monitor for this work request.
type WorkflowMonitor struct {
// workflow name for this work request
WorkflowName *string `mandatory:"false" json:"workflowName"`
// resource name for this work request
ResourceName *string `mandatory:"false" json:"resourceName"`
// Workflow step of workflow monitor.
WorkflowSteps []WorkflowStep `mandatory:"false" json:"workflowSteps"`
}
func (m WorkflowMonitor) String() string
func (m WorkflowMonitor) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkflowStep Workflow step of workflow monitor.
type WorkflowStep struct {
// workflow step name
StepName *string `mandatory:"false" json:"stepName"`
// workflow step status
Status *string `mandatory:"false" json:"status"`
}
func (m WorkflowStep) String() string
func (m WorkflowStep) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly