oce

package
v65.81.1 Latest Latest
Warning

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

 Go to latest Published: Dec 18, 2024 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetCreateOceInstanceDetailsInstanceAccessTypeEnumStringValues 

func GetCreateOceInstanceDetailsInstanceAccessTypeEnumStringValues() []string

GetCreateOceInstanceDetailsInstanceAccessTypeEnumStringValues Enumerates the set of values in String for CreateOceInstanceDetailsInstanceAccessTypeEnum

func GetCreateOceInstanceDetailsInstanceUsageTypeEnumStringValues 

func GetCreateOceInstanceDetailsInstanceUsageTypeEnumStringValues() []string

GetCreateOceInstanceDetailsInstanceUsageTypeEnumStringValues Enumerates the set of values in String for CreateOceInstanceDetailsInstanceUsageTypeEnum

func GetLicenseTypeEnumStringValues 

func GetLicenseTypeEnumStringValues() []string

GetLicenseTypeEnumStringValues Enumerates the set of values in String for LicenseTypeEnum

func GetLifecycleDetailsEnumStringValues 

func GetLifecycleDetailsEnumStringValues() []string

GetLifecycleDetailsEnumStringValues Enumerates the set of values in String for LifecycleDetailsEnum

func GetLifecycleStateEnumStringValues 

func GetLifecycleStateEnumStringValues() []string

GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum

func GetListOceInstancesLifecycleStateEnumStringValues 

func GetListOceInstancesLifecycleStateEnumStringValues() []string

GetListOceInstancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListOceInstancesLifecycleStateEnum

func GetListOceInstancesSortByEnumStringValues 

func GetListOceInstancesSortByEnumStringValues() []string

GetListOceInstancesSortByEnumStringValues Enumerates the set of values in String for ListOceInstancesSortByEnum

func GetListOceInstancesSortOrderEnumStringValues 

func GetListOceInstancesSortOrderEnumStringValues() []string

GetListOceInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListOceInstancesSortOrderEnum

func GetOceInstanceInstanceAccessTypeEnumStringValues 

func GetOceInstanceInstanceAccessTypeEnumStringValues() []string

GetOceInstanceInstanceAccessTypeEnumStringValues Enumerates the set of values in String for OceInstanceInstanceAccessTypeEnum

func GetOceInstanceInstanceUsageTypeEnumStringValues 

func GetOceInstanceInstanceUsageTypeEnumStringValues() []string

GetOceInstanceInstanceUsageTypeEnumStringValues Enumerates the set of values in String for OceInstanceInstanceUsageTypeEnum

func GetOceInstanceSummaryInstanceAccessTypeEnumStringValues 

func GetOceInstanceSummaryInstanceAccessTypeEnumStringValues() []string

GetOceInstanceSummaryInstanceAccessTypeEnumStringValues Enumerates the set of values in String for OceInstanceSummaryInstanceAccessTypeEnum

func GetOceInstanceSummaryInstanceUsageTypeEnumStringValues 

func GetOceInstanceSummaryInstanceUsageTypeEnumStringValues() []string

GetOceInstanceSummaryInstanceUsageTypeEnumStringValues Enumerates the set of values in String for OceInstanceSummaryInstanceUsageTypeEnum

func GetOceInstanceUpgradeScheduleEnumStringValues 

func GetOceInstanceUpgradeScheduleEnumStringValues() []string

GetOceInstanceUpgradeScheduleEnumStringValues Enumerates the set of values in String for OceInstanceUpgradeScheduleEnum

func GetUpdateOceInstanceDetailsInstanceUsageTypeEnumStringValues 

func GetUpdateOceInstanceDetailsInstanceUsageTypeEnumStringValues() []string

GetUpdateOceInstanceDetailsInstanceUsageTypeEnumStringValues Enumerates the set of values in String for UpdateOceInstanceDetailsInstanceUsageTypeEnum

func GetWorkRequestOperationTypeEnumStringValues 

func GetWorkRequestOperationTypeEnumStringValues() []string

GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum

func GetWorkRequestResourceActionTypeEnumStringValues 

func GetWorkRequestResourceActionTypeEnumStringValues() []string

GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum

func GetWorkRequestStatusEnumStringValues 

func GetWorkRequestStatusEnumStringValues() []string

GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum

Types

type ChangeOceInstanceCompartmentDetails 

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

ChangeOceInstanceCompartmentDetails The information about compartment details.

func (ChangeOceInstanceCompartmentDetails) String 

func (m ChangeOceInstanceCompartmentDetails) String() string

func (ChangeOceInstanceCompartmentDetails) ValidateEnumValue 

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

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

ChangeOceInstanceCompartmentRequest wrapper for the ChangeOceInstanceCompartment operation

See also

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

func (ChangeOceInstanceCompartmentRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeOceInstanceCompartmentRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ChangeOceInstanceCompartmentRequest) RetryPolicy 

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

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

func (ChangeOceInstanceCompartmentRequest) String 

func (request ChangeOceInstanceCompartmentRequest) String() string

func (ChangeOceInstanceCompartmentRequest) ValidateEnumValue 

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

type ChangeOceInstanceCompartmentResponse 

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

ChangeOceInstanceCompartmentResponse wrapper for the ChangeOceInstanceCompartment operation

func (ChangeOceInstanceCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ChangeOceInstanceCompartmentResponse) String 

func (response ChangeOceInstanceCompartmentResponse) String() string

type CreateOceInstanceDetails 

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

CreateOceInstanceDetails The information about new OceInstance.

func (CreateOceInstanceDetails) String 

func (m CreateOceInstanceDetails) String() string

func (CreateOceInstanceDetails) ValidateEnumValue 

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

type CreateOceInstanceDetailsInstanceAccessTypeEnum 

type CreateOceInstanceDetailsInstanceAccessTypeEnum string

CreateOceInstanceDetailsInstanceAccessTypeEnum Enum with underlying type: string 

const (
	CreateOceInstanceDetailsInstanceAccessTypePublic  CreateOceInstanceDetailsInstanceAccessTypeEnum = "PUBLIC"
	CreateOceInstanceDetailsInstanceAccessTypePrivate CreateOceInstanceDetailsInstanceAccessTypeEnum = "PRIVATE"
)

Set of constants representing the allowable values for CreateOceInstanceDetailsInstanceAccessTypeEnum

func GetCreateOceInstanceDetailsInstanceAccessTypeEnumValues 

func GetCreateOceInstanceDetailsInstanceAccessTypeEnumValues() []CreateOceInstanceDetailsInstanceAccessTypeEnum

GetCreateOceInstanceDetailsInstanceAccessTypeEnumValues Enumerates the set of values for CreateOceInstanceDetailsInstanceAccessTypeEnum

func GetMappingCreateOceInstanceDetailsInstanceAccessTypeEnum 

func GetMappingCreateOceInstanceDetailsInstanceAccessTypeEnum(val string) (CreateOceInstanceDetailsInstanceAccessTypeEnum, bool)

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

type CreateOceInstanceDetailsInstanceUsageTypeEnum 

type CreateOceInstanceDetailsInstanceUsageTypeEnum string

CreateOceInstanceDetailsInstanceUsageTypeEnum Enum with underlying type: string 

const (
	CreateOceInstanceDetailsInstanceUsageTypePrimary    CreateOceInstanceDetailsInstanceUsageTypeEnum = "PRIMARY"
	CreateOceInstanceDetailsInstanceUsageTypeNonprimary CreateOceInstanceDetailsInstanceUsageTypeEnum = "NONPRIMARY"
)

Set of constants representing the allowable values for CreateOceInstanceDetailsInstanceUsageTypeEnum

func GetCreateOceInstanceDetailsInstanceUsageTypeEnumValues 

func GetCreateOceInstanceDetailsInstanceUsageTypeEnumValues() []CreateOceInstanceDetailsInstanceUsageTypeEnum

GetCreateOceInstanceDetailsInstanceUsageTypeEnumValues Enumerates the set of values for CreateOceInstanceDetailsInstanceUsageTypeEnum

func GetMappingCreateOceInstanceDetailsInstanceUsageTypeEnum 

func GetMappingCreateOceInstanceDetailsInstanceUsageTypeEnum(val string) (CreateOceInstanceDetailsInstanceUsageTypeEnum, bool)

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

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

CreateOceInstanceRequest wrapper for the CreateOceInstance operation

See also

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

func (CreateOceInstanceRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateOceInstanceRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateOceInstanceRequest) RetryPolicy 

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

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

func (CreateOceInstanceRequest) String 

func (request CreateOceInstanceRequest) String() string

func (CreateOceInstanceRequest) ValidateEnumValue 

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

type CreateOceInstanceResponse 

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

CreateOceInstanceResponse wrapper for the CreateOceInstance operation

func (CreateOceInstanceResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateOceInstanceResponse) String 

func (response CreateOceInstanceResponse) String() string

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

DeleteOceInstanceRequest wrapper for the DeleteOceInstance operation

See also

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

func (DeleteOceInstanceRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteOceInstanceRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteOceInstanceRequest) RetryPolicy 

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

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

func (DeleteOceInstanceRequest) String 

func (request DeleteOceInstanceRequest) String() string

func (DeleteOceInstanceRequest) ValidateEnumValue 

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

type DeleteOceInstanceResponse 

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

DeleteOceInstanceResponse wrapper for the DeleteOceInstance operation

func (DeleteOceInstanceResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteOceInstanceResponse) String 

func (response DeleteOceInstanceResponse) String() string

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

GetOceInstanceRequest wrapper for the GetOceInstance operation

See also

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

func (GetOceInstanceRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetOceInstanceRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetOceInstanceRequest) RetryPolicy 

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

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

func (GetOceInstanceRequest) String 

func (request GetOceInstanceRequest) String() string

func (GetOceInstanceRequest) ValidateEnumValue 

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

type GetOceInstanceResponse 

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

GetOceInstanceResponse wrapper for the GetOceInstance operation

func (GetOceInstanceResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetOceInstanceResponse) String 

func (response GetOceInstanceResponse) String() string

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

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oce/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"`

	// some decimal number representing the number of seconds the client should wait before polling this endpoint again
	RetryAfter *float32 `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 IdentityStripeDetails 

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

IdentityStripeDetails Details of the identity stripe used for OceInstance

func (IdentityStripeDetails) String 

func (m IdentityStripeDetails) String() string

func (IdentityStripeDetails) ValidateEnumValue 

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

type LicenseTypeEnum 

type LicenseTypeEnum string

LicenseTypeEnum Enum with underlying type: string 

const (
	LicenseTypeNew     LicenseTypeEnum = "NEW"
	LicenseTypeByol    LicenseTypeEnum = "BYOL"
	LicenseTypePremium LicenseTypeEnum = "PREMIUM"
	LicenseTypeStarter LicenseTypeEnum = "STARTER"
)

Set of constants representing the allowable values for LicenseTypeEnum

func GetLicenseTypeEnumValues 

func GetLicenseTypeEnumValues() []LicenseTypeEnum

GetLicenseTypeEnumValues Enumerates the set of values for LicenseTypeEnum

func GetMappingLicenseTypeEnum 

func GetMappingLicenseTypeEnum(val string) (LicenseTypeEnum, bool)

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

type LifecycleDetailsEnum 

type LifecycleDetailsEnum string

LifecycleDetailsEnum Enum with underlying type: string 

const (
	LifecycleDetailsStandby  LifecycleDetailsEnum = "STANDBY"
	LifecycleDetailsFailover LifecycleDetailsEnum = "FAILOVER"
	LifecycleDetailsDown     LifecycleDetailsEnum = "DOWN"
	LifecycleDetailsPrimary  LifecycleDetailsEnum = "PRIMARY"
)

Set of constants representing the allowable values for LifecycleDetailsEnum

func GetLifecycleDetailsEnumValues 

func GetLifecycleDetailsEnumValues() []LifecycleDetailsEnum

GetLifecycleDetailsEnumValues Enumerates the set of values for LifecycleDetailsEnum

func GetMappingLifecycleDetailsEnum 

func GetMappingLifecycleDetailsEnum(val string) (LifecycleDetailsEnum, bool)

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

type LifecycleStateEnum 

type LifecycleStateEnum string

LifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for LifecycleStateEnum

func GetLifecycleStateEnumValues 

func GetLifecycleStateEnumValues() []LifecycleStateEnum

GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum

func GetMappingLifecycleStateEnum 

func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)

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

type ListOceInstancesLifecycleStateEnum 

type ListOceInstancesLifecycleStateEnum string

ListOceInstancesLifecycleStateEnum Enum with underlying type: string 

const (
	ListOceInstancesLifecycleStateCreating ListOceInstancesLifecycleStateEnum = "CREATING"
	ListOceInstancesLifecycleStateUpdating ListOceInstancesLifecycleStateEnum = "UPDATING"
	ListOceInstancesLifecycleStateActive   ListOceInstancesLifecycleStateEnum = "ACTIVE"
	ListOceInstancesLifecycleStateDeleting ListOceInstancesLifecycleStateEnum = "DELETING"
	ListOceInstancesLifecycleStateDeleted  ListOceInstancesLifecycleStateEnum = "DELETED"
	ListOceInstancesLifecycleStateFailed   ListOceInstancesLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ListOceInstancesLifecycleStateEnum

func GetListOceInstancesLifecycleStateEnumValues 

func GetListOceInstancesLifecycleStateEnumValues() []ListOceInstancesLifecycleStateEnum

GetListOceInstancesLifecycleStateEnumValues Enumerates the set of values for ListOceInstancesLifecycleStateEnum

func GetMappingListOceInstancesLifecycleStateEnum 

func GetMappingListOceInstancesLifecycleStateEnum(val string) (ListOceInstancesLifecycleStateEnum, bool)

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

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

ListOceInstancesRequest wrapper for the ListOceInstances operation

See also

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

func (ListOceInstancesRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListOceInstancesRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListOceInstancesRequest) RetryPolicy 

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

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

func (ListOceInstancesRequest) String 

func (request ListOceInstancesRequest) String() string

func (ListOceInstancesRequest) ValidateEnumValue 

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

type ListOceInstancesResponse 

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

ListOceInstancesResponse wrapper for the ListOceInstances operation

func (ListOceInstancesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListOceInstancesResponse) String 

func (response ListOceInstancesResponse) String() string

type ListOceInstancesSortByEnum 

type ListOceInstancesSortByEnum string

ListOceInstancesSortByEnum Enum with underlying type: string 

const (
	ListOceInstancesSortByTimecreated ListOceInstancesSortByEnum = "timeCreated"
	ListOceInstancesSortByDisplayname ListOceInstancesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListOceInstancesSortByEnum

func GetListOceInstancesSortByEnumValues 

func GetListOceInstancesSortByEnumValues() []ListOceInstancesSortByEnum

GetListOceInstancesSortByEnumValues Enumerates the set of values for ListOceInstancesSortByEnum

func GetMappingListOceInstancesSortByEnum 

func GetMappingListOceInstancesSortByEnum(val string) (ListOceInstancesSortByEnum, bool)

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

type ListOceInstancesSortOrderEnum 

type ListOceInstancesSortOrderEnum string

ListOceInstancesSortOrderEnum Enum with underlying type: string 

const (
	ListOceInstancesSortOrderAsc  ListOceInstancesSortOrderEnum = "ASC"
	ListOceInstancesSortOrderDesc ListOceInstancesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOceInstancesSortOrderEnum

func GetListOceInstancesSortOrderEnumValues 

func GetListOceInstancesSortOrderEnumValues() []ListOceInstancesSortOrderEnum

GetListOceInstancesSortOrderEnumValues Enumerates the set of values for ListOceInstancesSortOrderEnum

func GetMappingListOceInstancesSortOrderEnum 

func GetMappingListOceInstancesSortOrderEnum(val string) (ListOceInstancesSortOrderEnum, bool)

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

type ListWorkRequestErrorsRequest 

type ListWorkRequestErrorsRequest struct {

	// The ID of the asynchronous request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

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

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oce/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 []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"`
}

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

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oce/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 []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"`
}

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

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oce/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 []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"`
}

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

OceInstance Details of OceInstance.

func (OceInstance) String 

func (m OceInstance) String() string

func (OceInstance) ValidateEnumValue 

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

type OceInstanceClient 

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

OceInstanceClient a client for OceInstance

func NewOceInstanceClientWithConfigurationProvider 

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 

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

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/latest/oce/ChangeOceInstanceCompartment.go.html to see an example of how to use ChangeOceInstanceCompartment API. A default retry strategy applies to this operation ChangeOceInstanceCompartment()

func (*OceInstanceClient) ConfigurationProvider 

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

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

func (OceInstanceClient) CreateOceInstance 

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/latest/oce/CreateOceInstance.go.html to see an example of how to use CreateOceInstance API. A default retry strategy applies to this operation CreateOceInstance()

func (OceInstanceClient) DeleteOceInstance 

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/latest/oce/DeleteOceInstance.go.html to see an example of how to use DeleteOceInstance API. A default retry strategy applies to this operation DeleteOceInstance()

func (OceInstanceClient) GetOceInstance 

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/latest/oce/GetOceInstance.go.html to see an example of how to use GetOceInstance API. A default retry strategy applies to this operation GetOceInstance()

func (OceInstanceClient) GetWorkRequest 

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/latest/oce/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()

func (OceInstanceClient) ListOceInstances 

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/latest/oce/ListOceInstances.go.html to see an example of how to use ListOceInstances API. A default retry strategy applies to this operation ListOceInstances()

func (OceInstanceClient) ListWorkRequestErrors 

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/latest/oce/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()

func (OceInstanceClient) ListWorkRequestLogs 

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/latest/oce/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()

func (OceInstanceClient) ListWorkRequests 

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/latest/oce/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()

func (*OceInstanceClient) SetRegion 

func (client *OceInstanceClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (OceInstanceClient) UpdateOceInstance 

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/latest/oce/UpdateOceInstance.go.html to see an example of how to use UpdateOceInstance API. A default retry strategy applies to this operation UpdateOceInstance()

type OceInstanceInstanceAccessTypeEnum 

type OceInstanceInstanceAccessTypeEnum string

OceInstanceInstanceAccessTypeEnum Enum with underlying type: string 

const (
	OceInstanceInstanceAccessTypePublic  OceInstanceInstanceAccessTypeEnum = "PUBLIC"
	OceInstanceInstanceAccessTypePrivate OceInstanceInstanceAccessTypeEnum = "PRIVATE"
)

Set of constants representing the allowable values for OceInstanceInstanceAccessTypeEnum

func GetMappingOceInstanceInstanceAccessTypeEnum 

func GetMappingOceInstanceInstanceAccessTypeEnum(val string) (OceInstanceInstanceAccessTypeEnum, bool)

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

func GetOceInstanceInstanceAccessTypeEnumValues 

func GetOceInstanceInstanceAccessTypeEnumValues() []OceInstanceInstanceAccessTypeEnum

GetOceInstanceInstanceAccessTypeEnumValues Enumerates the set of values for OceInstanceInstanceAccessTypeEnum

type OceInstanceInstanceUsageTypeEnum 

type OceInstanceInstanceUsageTypeEnum string

OceInstanceInstanceUsageTypeEnum Enum with underlying type: string 

const (
	OceInstanceInstanceUsageTypePrimary    OceInstanceInstanceUsageTypeEnum = "PRIMARY"
	OceInstanceInstanceUsageTypeNonprimary OceInstanceInstanceUsageTypeEnum = "NONPRIMARY"
)

Set of constants representing the allowable values for OceInstanceInstanceUsageTypeEnum

func GetMappingOceInstanceInstanceUsageTypeEnum 

func GetMappingOceInstanceInstanceUsageTypeEnum(val string) (OceInstanceInstanceUsageTypeEnum, bool)

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

func GetOceInstanceInstanceUsageTypeEnumValues 

func GetOceInstanceInstanceUsageTypeEnumValues() []OceInstanceInstanceUsageTypeEnum

GetOceInstanceInstanceUsageTypeEnumValues Enumerates the set of values for OceInstanceInstanceUsageTypeEnum

type OceInstanceSummary 

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

OceInstanceSummary Summary of the OceInstance.

func (OceInstanceSummary) String 

func (m OceInstanceSummary) String() string

func (OceInstanceSummary) ValidateEnumValue 

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

type OceInstanceSummaryInstanceAccessTypeEnum 

type OceInstanceSummaryInstanceAccessTypeEnum string

OceInstanceSummaryInstanceAccessTypeEnum Enum with underlying type: string 

const (
	OceInstanceSummaryInstanceAccessTypePublic  OceInstanceSummaryInstanceAccessTypeEnum = "PUBLIC"
	OceInstanceSummaryInstanceAccessTypePrivate OceInstanceSummaryInstanceAccessTypeEnum = "PRIVATE"
)

Set of constants representing the allowable values for OceInstanceSummaryInstanceAccessTypeEnum

func GetMappingOceInstanceSummaryInstanceAccessTypeEnum 

func GetMappingOceInstanceSummaryInstanceAccessTypeEnum(val string) (OceInstanceSummaryInstanceAccessTypeEnum, bool)

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

func GetOceInstanceSummaryInstanceAccessTypeEnumValues 

func GetOceInstanceSummaryInstanceAccessTypeEnumValues() []OceInstanceSummaryInstanceAccessTypeEnum

GetOceInstanceSummaryInstanceAccessTypeEnumValues Enumerates the set of values for OceInstanceSummaryInstanceAccessTypeEnum

type OceInstanceSummaryInstanceUsageTypeEnum 

type OceInstanceSummaryInstanceUsageTypeEnum string

OceInstanceSummaryInstanceUsageTypeEnum Enum with underlying type: string 

const (
	OceInstanceSummaryInstanceUsageTypePrimary    OceInstanceSummaryInstanceUsageTypeEnum = "PRIMARY"
	OceInstanceSummaryInstanceUsageTypeNonprimary OceInstanceSummaryInstanceUsageTypeEnum = "NONPRIMARY"
)

Set of constants representing the allowable values for OceInstanceSummaryInstanceUsageTypeEnum

func GetMappingOceInstanceSummaryInstanceUsageTypeEnum 

func GetMappingOceInstanceSummaryInstanceUsageTypeEnum(val string) (OceInstanceSummaryInstanceUsageTypeEnum, bool)

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

func GetOceInstanceSummaryInstanceUsageTypeEnumValues 

func GetOceInstanceSummaryInstanceUsageTypeEnumValues() []OceInstanceSummaryInstanceUsageTypeEnum

GetOceInstanceSummaryInstanceUsageTypeEnumValues Enumerates the set of values for OceInstanceSummaryInstanceUsageTypeEnum

type OceInstanceUpgradeScheduleEnum 

type OceInstanceUpgradeScheduleEnum string

OceInstanceUpgradeScheduleEnum Enum with underlying type: string 

const (
	OceInstanceUpgradeScheduleUpgradeImmediately OceInstanceUpgradeScheduleEnum = "UPGRADE_IMMEDIATELY"
	OceInstanceUpgradeScheduleDelayedUpgrade     OceInstanceUpgradeScheduleEnum = "DELAYED_UPGRADE"
)

Set of constants representing the allowable values for OceInstanceUpgradeScheduleEnum

func GetMappingOceInstanceUpgradeScheduleEnum 

func GetMappingOceInstanceUpgradeScheduleEnum(val string) (OceInstanceUpgradeScheduleEnum, bool)

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

func GetOceInstanceUpgradeScheduleEnumValues 

func GetOceInstanceUpgradeScheduleEnumValues() []OceInstanceUpgradeScheduleEnum

GetOceInstanceUpgradeScheduleEnumValues Enumerates the set of values for OceInstanceUpgradeScheduleEnum

type UpdateOceInstanceDetails 

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

UpdateOceInstanceDetails The information to be updated.

func (UpdateOceInstanceDetails) String 

func (m UpdateOceInstanceDetails) String() string

func (UpdateOceInstanceDetails) ValidateEnumValue 

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

type UpdateOceInstanceDetailsInstanceUsageTypeEnum 

type UpdateOceInstanceDetailsInstanceUsageTypeEnum string

UpdateOceInstanceDetailsInstanceUsageTypeEnum Enum with underlying type: string 

const (
	UpdateOceInstanceDetailsInstanceUsageTypePrimary    UpdateOceInstanceDetailsInstanceUsageTypeEnum = "PRIMARY"
	UpdateOceInstanceDetailsInstanceUsageTypeNonprimary UpdateOceInstanceDetailsInstanceUsageTypeEnum = "NONPRIMARY"
)

Set of constants representing the allowable values for UpdateOceInstanceDetailsInstanceUsageTypeEnum

func GetMappingUpdateOceInstanceDetailsInstanceUsageTypeEnum 

func GetMappingUpdateOceInstanceDetailsInstanceUsageTypeEnum(val string) (UpdateOceInstanceDetailsInstanceUsageTypeEnum, bool)

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

func GetUpdateOceInstanceDetailsInstanceUsageTypeEnumValues 

func GetUpdateOceInstanceDetailsInstanceUsageTypeEnumValues() []UpdateOceInstanceDetailsInstanceUsageTypeEnum

GetUpdateOceInstanceDetailsInstanceUsageTypeEnumValues Enumerates the set of values for UpdateOceInstanceDetailsInstanceUsageTypeEnum

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

UpdateOceInstanceRequest wrapper for the UpdateOceInstance operation

See also

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

func (UpdateOceInstanceRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateOceInstanceRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateOceInstanceRequest) RetryPolicy 

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

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

func (UpdateOceInstanceRequest) String 

func (request UpdateOceInstanceRequest) String() string

func (UpdateOceInstanceRequest) ValidateEnumValue 

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

type UpdateOceInstanceResponse 

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

UpdateOceInstanceResponse wrapper for the UpdateOceInstance operation

func (UpdateOceInstanceResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateOceInstanceResponse) String 

func (response UpdateOceInstanceResponse) String() string

type WorkRequest 

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

WorkRequest A description of workrequest status

func (WorkRequest) String 

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue 

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

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

type WorkRequestError 

type WorkRequestError struct {

	// A machine-usable code for the error that occured. Error codes are listed on
	// (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
	Code *string `mandatory:"true" json:"code"`

	// A human readable description of the issue encountered.
	Message *string `mandatory:"true" json:"message"`

	// The time the error occured. An RFC3339 formatted datetime string.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String 

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue 

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

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

type WorkRequestLogEntry 

type WorkRequestLogEntry struct {

	// Human-readable log message.
	Message *string `mandatory:"true" json:"message"`

	// The time the log message was written. An RFC3339 formatted datetime string
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

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

func (WorkRequestLogEntry) String 

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue 

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

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

type WorkRequestOperationTypeEnum 

type WorkRequestOperationTypeEnum string

WorkRequestOperationTypeEnum Enum with underlying type: string 

const (
	WorkRequestOperationTypeCreateOceInstance WorkRequestOperationTypeEnum = "CREATE_OCE_INSTANCE"
	WorkRequestOperationTypeUpdateOceInstance WorkRequestOperationTypeEnum = "UPDATE_OCE_INSTANCE"
	WorkRequestOperationTypeDeleteOceInstance WorkRequestOperationTypeEnum = "DELETE_OCE_INSTANCE"
)

Set of constants representing the allowable values for WorkRequestOperationTypeEnum

func GetMappingWorkRequestOperationTypeEnum 

func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)

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

func GetWorkRequestOperationTypeEnumValues 

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource 

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

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 WorkRequestResourceActionTypeEnum 

type WorkRequestResourceActionTypeEnum string

WorkRequestResourceActionTypeEnum Enum with underlying type: string 

const (
	WorkRequestResourceActionTypeCreated    WorkRequestResourceActionTypeEnum = "CREATED"
	WorkRequestResourceActionTypeUpdated    WorkRequestResourceActionTypeEnum = "UPDATED"
	WorkRequestResourceActionTypeDeleted    WorkRequestResourceActionTypeEnum = "DELETED"
	WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
	WorkRequestResourceActionTypeFailed     WorkRequestResourceActionTypeEnum = "FAILED"
)

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

func GetMappingWorkRequestResourceActionTypeEnum 

func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)

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

func GetWorkRequestResourceActionTypeEnumValues 

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestStatusEnum 

type WorkRequestStatusEnum string

WorkRequestStatusEnum Enum with underlying type: string 

const (
	WorkRequestStatusAccepted   WorkRequestStatusEnum = "ACCEPTED"
	WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
	WorkRequestStatusFailed     WorkRequestStatusEnum = "FAILED"
	WorkRequestStatusSucceeded  WorkRequestStatusEnum = "SUCCEEDED"
	WorkRequestStatusCanceling  WorkRequestStatusEnum = "CANCELING"
	WorkRequestStatusCanceled   WorkRequestStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestStatusEnum

func GetMappingWorkRequestStatusEnum 

func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)

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

func GetWorkRequestStatusEnumValues 

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkflowMonitor 

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

WorkflowMonitor The workflow monitor for this work request.

func (WorkflowMonitor) String 

func (m WorkflowMonitor) String() string

func (WorkflowMonitor) ValidateEnumValue 

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

type WorkflowStep 

type WorkflowStep struct {

	// workflow step name
	StepName *string `mandatory:"false" json:"stepName"`

	// workflow step status
	Status *string `mandatory:"false" json:"status"`
}

WorkflowStep Workflow step of workflow monitor.

func (WorkflowStep) String 

func (m WorkflowStep) String() string

func (WorkflowStep) ValidateEnumValue 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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