...

Package oce

import "github.com/oracle/oci-go-sdk/oce"
Overview
Index

Overview ▾

Index ▾

type ChangeOceInstanceCompartmentDetails
    func (m ChangeOceInstanceCompartmentDetails) String() string
type ChangeOceInstanceCompartmentRequest
    func (request ChangeOceInstanceCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeOceInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeOceInstanceCompartmentRequest) String() string
type ChangeOceInstanceCompartmentResponse
    func (response ChangeOceInstanceCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeOceInstanceCompartmentResponse) String() string
type CreateOceInstanceDetails
    func (m CreateOceInstanceDetails) String() string
type CreateOceInstanceDetailsInstanceAccessTypeEnum
    func GetCreateOceInstanceDetailsInstanceAccessTypeEnumValues() []CreateOceInstanceDetailsInstanceAccessTypeEnum
type CreateOceInstanceDetailsInstanceUsageTypeEnum
    func GetCreateOceInstanceDetailsInstanceUsageTypeEnumValues() []CreateOceInstanceDetailsInstanceUsageTypeEnum
type CreateOceInstanceRequest
    func (request CreateOceInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateOceInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateOceInstanceRequest) String() string
type CreateOceInstanceResponse
    func (response CreateOceInstanceResponse) HTTPResponse() *http.Response
    func (response CreateOceInstanceResponse) String() string
type DeleteOceInstanceRequest
    func (request DeleteOceInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteOceInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteOceInstanceRequest) String() string
type DeleteOceInstanceResponse
    func (response DeleteOceInstanceResponse) HTTPResponse() *http.Response
    func (response DeleteOceInstanceResponse) String() string
type GetOceInstanceRequest
    func (request GetOceInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetOceInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request GetOceInstanceRequest) String() string
type GetOceInstanceResponse
    func (response GetOceInstanceResponse) HTTPResponse() *http.Response
    func (response GetOceInstanceResponse) String() string
type GetWorkRequestRequest
    func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request GetWorkRequestRequest) String() string
type GetWorkRequestResponse
    func (response GetWorkRequestResponse) HTTPResponse() *http.Response
    func (response GetWorkRequestResponse) String() string
type IdentityStripeDetails
    func (m IdentityStripeDetails) String() string
type LicenseTypeEnum
    func GetLicenseTypeEnumValues() []LicenseTypeEnum
type ListOceInstancesLifecycleStateEnum
    func GetListOceInstancesLifecycleStateEnumValues() []ListOceInstancesLifecycleStateEnum
type ListOceInstancesRequest
    func (request ListOceInstancesRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListOceInstancesRequest) RetryPolicy() *common.RetryPolicy
    func (request ListOceInstancesRequest) String() string
type ListOceInstancesResponse
    func (response ListOceInstancesResponse) HTTPResponse() *http.Response
    func (response ListOceInstancesResponse) String() string
type ListOceInstancesSortByEnum
    func GetListOceInstancesSortByEnumValues() []ListOceInstancesSortByEnum
type ListOceInstancesSortOrderEnum
    func GetListOceInstancesSortOrderEnumValues() []ListOceInstancesSortOrderEnum
type ListWorkRequestErrorsRequest
    func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestErrorsRequest) String() string
type ListWorkRequestErrorsResponse
    func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestErrorsResponse) String() string
type ListWorkRequestLogsRequest
    func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestLogsRequest) String() string
type ListWorkRequestLogsResponse
    func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestLogsResponse) String() string
type ListWorkRequestsRequest
    func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestsRequest) String() string
type ListWorkRequestsResponse
    func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestsResponse) String() string
type OceInstance
    func (m OceInstance) String() string
type OceInstanceClient
    func NewOceInstanceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OceInstanceClient, err error)
    func NewOceInstanceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OceInstanceClient, err error)
    func (client OceInstanceClient) ChangeOceInstanceCompartment(ctx context.Context, request ChangeOceInstanceCompartmentRequest) (response ChangeOceInstanceCompartmentResponse, err error)
    func (client *OceInstanceClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client OceInstanceClient) CreateOceInstance(ctx context.Context, request CreateOceInstanceRequest) (response CreateOceInstanceResponse, err error)
    func (client OceInstanceClient) DeleteOceInstance(ctx context.Context, request DeleteOceInstanceRequest) (response DeleteOceInstanceResponse, err error)
    func (client OceInstanceClient) GetOceInstance(ctx context.Context, request GetOceInstanceRequest) (response GetOceInstanceResponse, err error)
    func (client OceInstanceClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
    func (client OceInstanceClient) ListOceInstances(ctx context.Context, request ListOceInstancesRequest) (response ListOceInstancesResponse, err error)
    func (client OceInstanceClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
    func (client OceInstanceClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
    func (client OceInstanceClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
    func (client *OceInstanceClient) SetRegion(region string)
    func (client OceInstanceClient) UpdateOceInstance(ctx context.Context, request UpdateOceInstanceRequest) (response UpdateOceInstanceResponse, err error)
type OceInstanceInstanceAccessTypeEnum
    func GetOceInstanceInstanceAccessTypeEnumValues() []OceInstanceInstanceAccessTypeEnum
type OceInstanceInstanceUsageTypeEnum
    func GetOceInstanceInstanceUsageTypeEnumValues() []OceInstanceInstanceUsageTypeEnum
type OceInstanceLifecycleStateEnum
    func GetOceInstanceLifecycleStateEnumValues() []OceInstanceLifecycleStateEnum
type OceInstanceSummary
    func (m OceInstanceSummary) String() string
type OceInstanceSummaryInstanceAccessTypeEnum
    func GetOceInstanceSummaryInstanceAccessTypeEnumValues() []OceInstanceSummaryInstanceAccessTypeEnum
type OceInstanceSummaryInstanceUsageTypeEnum
    func GetOceInstanceSummaryInstanceUsageTypeEnumValues() []OceInstanceSummaryInstanceUsageTypeEnum
type OceInstanceSummaryLifecycleStateEnum
    func GetOceInstanceSummaryLifecycleStateEnumValues() []OceInstanceSummaryLifecycleStateEnum
type OceInstanceUpgradeScheduleEnum
    func GetOceInstanceUpgradeScheduleEnumValues() []OceInstanceUpgradeScheduleEnum
type UpdateOceInstanceDetails
    func (m UpdateOceInstanceDetails) String() string
type UpdateOceInstanceRequest
    func (request UpdateOceInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateOceInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateOceInstanceRequest) String() string
type UpdateOceInstanceResponse
    func (response UpdateOceInstanceResponse) HTTPResponse() *http.Response
    func (response UpdateOceInstanceResponse) String() string
type WorkRequest
    func (m WorkRequest) String() string
type WorkRequestError
    func (m WorkRequestError) String() string
type WorkRequestLogEntry
    func (m WorkRequestLogEntry) String() string
type WorkRequestOperationTypeEnum
    func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
type WorkRequestResource
    func (m WorkRequestResource) String() string
type WorkRequestResourceActionTypeEnum
    func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
type WorkRequestStatusEnum
    func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
type WorkflowMonitor
    func (m WorkflowMonitor) String() string
type WorkflowStep
    func (m WorkflowStep) String() string

Package files

change_oce_instance_compartment_details.go change_oce_instance_compartment_request_response.go create_oce_instance_details.go create_oce_instance_request_response.go delete_oce_instance_request_response.go get_oce_instance_request_response.go get_work_request_request_response.go identity_stripe_details.go license_type.go list_oce_instances_request_response.go list_work_request_errors_request_response.go list_work_request_logs_request_response.go list_work_requests_request_response.go oce_instance.go oce_instance_summary.go oce_oceinstance_client.go update_oce_instance_details.go update_oce_instance_request_response.go work_request.go work_request_error.go work_request_log_entry.go work_request_resource.go workflow_monitor.go workflow_step.go

type ChangeOceInstanceCompartmentDetails

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

func (m ChangeOceInstanceCompartmentDetails) String() string

type ChangeOceInstanceCompartmentRequest

ChangeOceInstanceCompartmentRequest wrapper for the ChangeOceInstanceCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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 (ChangeOceInstanceCompartmentRequest) HTTPRequest

func (request ChangeOceInstanceCompartmentRequest) HTTPRequest(method, path 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

type ChangeOceInstanceCompartmentResponse

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

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

HTTPResponse implements the OCIResponse interface

func (ChangeOceInstanceCompartmentResponse) String

func (response ChangeOceInstanceCompartmentResponse) String() string

type CreateOceInstanceDetails

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

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

    // 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 (CreateOceInstanceDetails) String

func (m CreateOceInstanceDetails) String() string

type CreateOceInstanceDetailsInstanceAccessTypeEnum

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

func GetCreateOceInstanceDetailsInstanceAccessTypeEnumValues() []CreateOceInstanceDetailsInstanceAccessTypeEnum

GetCreateOceInstanceDetailsInstanceAccessTypeEnumValues Enumerates the set of values for CreateOceInstanceDetailsInstanceAccessTypeEnum

type CreateOceInstanceDetailsInstanceUsageTypeEnum

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

func GetCreateOceInstanceDetailsInstanceUsageTypeEnumValues() []CreateOceInstanceDetailsInstanceUsageTypeEnum

GetCreateOceInstanceDetailsInstanceUsageTypeEnumValues Enumerates the set of values for CreateOceInstanceDetailsInstanceUsageTypeEnum

type CreateOceInstanceRequest

CreateOceInstanceRequest wrapper for the CreateOceInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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 (CreateOceInstanceRequest) HTTPRequest

func (request CreateOceInstanceRequest) HTTPRequest(method, path 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

type CreateOceInstanceResponse

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

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

HTTPResponse implements the OCIResponse interface

func (CreateOceInstanceResponse) String

func (response CreateOceInstanceResponse) String() string

type DeleteOceInstanceRequest

DeleteOceInstanceRequest wrapper for the DeleteOceInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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 (DeleteOceInstanceRequest) HTTPRequest

func (request DeleteOceInstanceRequest) HTTPRequest(method, path 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

type DeleteOceInstanceResponse

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

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

HTTPResponse implements the OCIResponse interface

func (DeleteOceInstanceResponse) String

func (response DeleteOceInstanceResponse) String() string

type GetOceInstanceRequest

GetOceInstanceRequest wrapper for the GetOceInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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 (GetOceInstanceRequest) HTTPRequest

func (request GetOceInstanceRequest) HTTPRequest(method, path 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

type GetOceInstanceResponse

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

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

HTTPResponse implements the OCIResponse interface

func (GetOceInstanceResponse) String

func (response GetOceInstanceResponse) String() string

type GetWorkRequestRequest

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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 (GetWorkRequestRequest) HTTPRequest

func (request GetWorkRequestRequest) HTTPRequest(method, path 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

type GetWorkRequestResponse

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

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type IdentityStripeDetails

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

func (m IdentityStripeDetails) String() string

type LicenseTypeEnum

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

func GetLicenseTypeEnumValues

func GetLicenseTypeEnumValues() []LicenseTypeEnum

GetLicenseTypeEnumValues Enumerates the set of values for LicenseTypeEnum

type ListOceInstancesLifecycleStateEnum

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

func GetListOceInstancesLifecycleStateEnumValues() []ListOceInstancesLifecycleStateEnum

GetListOceInstancesLifecycleStateEnumValues Enumerates the set of values for ListOceInstancesLifecycleStateEnum

type ListOceInstancesRequest

ListOceInstancesRequest wrapper for the ListOceInstances operation

See also

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

    // 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 (ListOceInstancesRequest) HTTPRequest

func (request ListOceInstancesRequest) HTTPRequest(method, path 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

type ListOceInstancesResponse

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

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

HTTPResponse implements the OCIResponse interface

func (ListOceInstancesResponse) String

func (response ListOceInstancesResponse) String() string

type ListOceInstancesSortByEnum

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

func GetListOceInstancesSortByEnumValues() []ListOceInstancesSortByEnum

GetListOceInstancesSortByEnumValues Enumerates the set of values for ListOceInstancesSortByEnum

type ListOceInstancesSortOrderEnum

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

func GetListOceInstancesSortOrderEnumValues() []ListOceInstancesSortOrderEnum

GetListOceInstancesSortOrderEnumValues Enumerates the set of values for ListOceInstancesSortOrderEnum

type ListWorkRequestErrorsRequest

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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 (ListWorkRequestErrorsRequest) HTTPRequest

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path 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

type ListWorkRequestErrorsResponse

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

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestLogsRequest

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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 (ListWorkRequestLogsRequest) HTTPRequest

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path 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

type ListWorkRequestLogsResponse

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

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestsRequest

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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 (ListWorkRequestsRequest) HTTPRequest

func (request ListWorkRequestsRequest) HTTPRequest(method, path 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

type ListWorkRequestsResponse

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

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type OceInstance

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

    // 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 file system.
    LifecycleState OceInstanceLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

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

    // SERVICE data.
    // Example: `{"service": {"IDCS": "value"}}`
    Service map[string]interface{} `mandatory:"false" json:"service"`
}

func (OceInstance) String

func (m OceInstance) String() string

type OceInstanceClient

OceInstanceClient a client for OceInstance

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

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/36.1.0/oce/ChangeOceInstanceCompartment.go.html to see an example of how to use ChangeOceInstanceCompartment API.

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/36.1.0/oce/CreateOceInstance.go.html to see an example of how to use CreateOceInstance API.

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/36.1.0/oce/DeleteOceInstance.go.html to see an example of how to use DeleteOceInstance API.

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/36.1.0/oce/GetOceInstance.go.html to see an example of how to use GetOceInstance API.

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/36.1.0/oce/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.

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/36.1.0/oce/ListOceInstances.go.html to see an example of how to use ListOceInstances API.

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/36.1.0/oce/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.

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/36.1.0/oce/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.

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/36.1.0/oce/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.

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/36.1.0/oce/UpdateOceInstance.go.html to see an example of how to use UpdateOceInstance API.

type OceInstanceInstanceAccessTypeEnum

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 GetOceInstanceInstanceAccessTypeEnumValues

func GetOceInstanceInstanceAccessTypeEnumValues() []OceInstanceInstanceAccessTypeEnum

GetOceInstanceInstanceAccessTypeEnumValues Enumerates the set of values for OceInstanceInstanceAccessTypeEnum

type OceInstanceInstanceUsageTypeEnum

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 GetOceInstanceInstanceUsageTypeEnumValues

func GetOceInstanceInstanceUsageTypeEnumValues() []OceInstanceInstanceUsageTypeEnum

GetOceInstanceInstanceUsageTypeEnumValues Enumerates the set of values for OceInstanceInstanceUsageTypeEnum

type OceInstanceLifecycleStateEnum

OceInstanceLifecycleStateEnum Enum with underlying type: string

type OceInstanceLifecycleStateEnum string

Set of constants representing the allowable values for OceInstanceLifecycleStateEnum

const (
    OceInstanceLifecycleStateCreating OceInstanceLifecycleStateEnum = "CREATING"
    OceInstanceLifecycleStateUpdating OceInstanceLifecycleStateEnum = "UPDATING"
    OceInstanceLifecycleStateActive   OceInstanceLifecycleStateEnum = "ACTIVE"
    OceInstanceLifecycleStateDeleting OceInstanceLifecycleStateEnum = "DELETING"
    OceInstanceLifecycleStateDeleted  OceInstanceLifecycleStateEnum = "DELETED"
    OceInstanceLifecycleStateFailed   OceInstanceLifecycleStateEnum = "FAILED"
)

func GetOceInstanceLifecycleStateEnumValues

func GetOceInstanceLifecycleStateEnumValues() []OceInstanceLifecycleStateEnum

GetOceInstanceLifecycleStateEnumValues Enumerates the set of values for OceInstanceLifecycleStateEnum

type OceInstanceSummary

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

    // 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 file system.
    LifecycleState OceInstanceSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

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

func (OceInstanceSummary) String

func (m OceInstanceSummary) String() string

type OceInstanceSummaryInstanceAccessTypeEnum

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 GetOceInstanceSummaryInstanceAccessTypeEnumValues

func GetOceInstanceSummaryInstanceAccessTypeEnumValues() []OceInstanceSummaryInstanceAccessTypeEnum

GetOceInstanceSummaryInstanceAccessTypeEnumValues Enumerates the set of values for OceInstanceSummaryInstanceAccessTypeEnum

type OceInstanceSummaryInstanceUsageTypeEnum

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 GetOceInstanceSummaryInstanceUsageTypeEnumValues

func GetOceInstanceSummaryInstanceUsageTypeEnumValues() []OceInstanceSummaryInstanceUsageTypeEnum

GetOceInstanceSummaryInstanceUsageTypeEnumValues Enumerates the set of values for OceInstanceSummaryInstanceUsageTypeEnum

type OceInstanceSummaryLifecycleStateEnum

OceInstanceSummaryLifecycleStateEnum Enum with underlying type: string

type OceInstanceSummaryLifecycleStateEnum string

Set of constants representing the allowable values for OceInstanceSummaryLifecycleStateEnum

const (
    OceInstanceSummaryLifecycleStateCreating OceInstanceSummaryLifecycleStateEnum = "CREATING"
    OceInstanceSummaryLifecycleStateUpdating OceInstanceSummaryLifecycleStateEnum = "UPDATING"
    OceInstanceSummaryLifecycleStateActive   OceInstanceSummaryLifecycleStateEnum = "ACTIVE"
    OceInstanceSummaryLifecycleStateDeleting OceInstanceSummaryLifecycleStateEnum = "DELETING"
    OceInstanceSummaryLifecycleStateDeleted  OceInstanceSummaryLifecycleStateEnum = "DELETED"
    OceInstanceSummaryLifecycleStateFailed   OceInstanceSummaryLifecycleStateEnum = "FAILED"
)

func GetOceInstanceSummaryLifecycleStateEnumValues

func GetOceInstanceSummaryLifecycleStateEnumValues() []OceInstanceSummaryLifecycleStateEnum

GetOceInstanceSummaryLifecycleStateEnumValues Enumerates the set of values for OceInstanceSummaryLifecycleStateEnum

type OceInstanceUpgradeScheduleEnum

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 GetOceInstanceUpgradeScheduleEnumValues

func GetOceInstanceUpgradeScheduleEnumValues() []OceInstanceUpgradeScheduleEnum

GetOceInstanceUpgradeScheduleEnumValues Enumerates the set of values for OceInstanceUpgradeScheduleEnum

type UpdateOceInstanceDetails

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

    // 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 (UpdateOceInstanceDetails) String

func (m UpdateOceInstanceDetails) String() string

type UpdateOceInstanceRequest

UpdateOceInstanceRequest wrapper for the UpdateOceInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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 (UpdateOceInstanceRequest) HTTPRequest

func (request UpdateOceInstanceRequest) HTTPRequest(method, path 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

type UpdateOceInstanceResponse

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

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

HTTPResponse implements the OCIResponse interface

func (UpdateOceInstanceResponse) String

func (response UpdateOceInstanceResponse) String() string

type WorkRequest

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

func (m WorkRequest) String() string

type WorkRequestError

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

func (m WorkRequestError) String() string

type WorkRequestLogEntry

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

func (m WorkRequestLogEntry) String() string

type WorkRequestOperationTypeEnum

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 GetWorkRequestOperationTypeEnumValues

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource

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

func (m WorkRequestResource) String() string

type WorkRequestResourceActionTypeEnum

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 GetWorkRequestResourceActionTypeEnumValues

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestStatusEnum

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 GetWorkRequestStatusEnumValues

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkflowMonitor

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

func (m WorkflowMonitor) String() string

type WorkflowStep

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

func (m WorkflowStep) String() string