...

Package vbsinst

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

Overview ▾

Index ▾

func GetActionTypeEnumStringValues() []string
func GetLifecycleStateEnumStringValues() []string
func GetListVbsInstancesLifecycleStateEnumStringValues() []string
func GetListVbsInstancesSortByEnumStringValues() []string
func GetListVbsInstancesSortOrderEnumStringValues() []string
func GetListWorkRequestErrorsSortByEnumStringValues() []string
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
func GetListWorkRequestLogsSortByEnumStringValues() []string
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
func GetListWorkRequestsSortByEnumStringValues() []string
func GetListWorkRequestsSortOrderEnumStringValues() []string
func GetOperationStatusEnumStringValues() []string
func GetOperationTypeEnumStringValues() []string
func GetSortOrderEnumStringValues() []string
type ActionTypeEnum
    func GetActionTypeEnumValues() []ActionTypeEnum
    func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
type ChangeVbsInstanceCompartmentDetails
    func (m ChangeVbsInstanceCompartmentDetails) String() string
    func (m ChangeVbsInstanceCompartmentDetails) ValidateEnumValue() (bool, error)
type ChangeVbsInstanceCompartmentRequest
    func (request ChangeVbsInstanceCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ChangeVbsInstanceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ChangeVbsInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeVbsInstanceCompartmentRequest) String() string
    func (request ChangeVbsInstanceCompartmentRequest) ValidateEnumValue() (bool, error)
type ChangeVbsInstanceCompartmentResponse
    func (response ChangeVbsInstanceCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeVbsInstanceCompartmentResponse) String() string
type CreateVbsInstanceDetails
    func (m CreateVbsInstanceDetails) String() string
    func (m CreateVbsInstanceDetails) ValidateEnumValue() (bool, error)
type CreateVbsInstanceRequest
    func (request CreateVbsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request CreateVbsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request CreateVbsInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateVbsInstanceRequest) String() string
    func (request CreateVbsInstanceRequest) ValidateEnumValue() (bool, error)
type CreateVbsInstanceResponse
    func (response CreateVbsInstanceResponse) HTTPResponse() *http.Response
    func (response CreateVbsInstanceResponse) String() string
type DeleteVbsInstanceRequest
    func (request DeleteVbsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request DeleteVbsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request DeleteVbsInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteVbsInstanceRequest) String() string
    func (request DeleteVbsInstanceRequest) ValidateEnumValue() (bool, error)
type DeleteVbsInstanceResponse
    func (response DeleteVbsInstanceResponse) HTTPResponse() *http.Response
    func (response DeleteVbsInstanceResponse) String() string
type GetVbsInstanceRequest
    func (request GetVbsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request GetVbsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request GetVbsInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request GetVbsInstanceRequest) String() string
    func (request GetVbsInstanceRequest) ValidateEnumValue() (bool, error)
type GetVbsInstanceResponse
    func (response GetVbsInstanceResponse) HTTPResponse() *http.Response
    func (response GetVbsInstanceResponse) String() string
type GetWorkRequestRequest
    func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request GetWorkRequestRequest) String() string
    func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
type GetWorkRequestResponse
    func (response GetWorkRequestResponse) HTTPResponse() *http.Response
    func (response GetWorkRequestResponse) String() string
type LifecycleStateEnum
    func GetLifecycleStateEnumValues() []LifecycleStateEnum
    func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
type ListVbsInstancesLifecycleStateEnum
    func GetListVbsInstancesLifecycleStateEnumValues() []ListVbsInstancesLifecycleStateEnum
    func GetMappingListVbsInstancesLifecycleStateEnum(val string) (ListVbsInstancesLifecycleStateEnum, bool)
type ListVbsInstancesRequest
    func (request ListVbsInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListVbsInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListVbsInstancesRequest) RetryPolicy() *common.RetryPolicy
    func (request ListVbsInstancesRequest) String() string
    func (request ListVbsInstancesRequest) ValidateEnumValue() (bool, error)
type ListVbsInstancesResponse
    func (response ListVbsInstancesResponse) HTTPResponse() *http.Response
    func (response ListVbsInstancesResponse) String() string
type ListVbsInstancesSortByEnum
    func GetListVbsInstancesSortByEnumValues() []ListVbsInstancesSortByEnum
    func GetMappingListVbsInstancesSortByEnum(val string) (ListVbsInstancesSortByEnum, bool)
type ListVbsInstancesSortOrderEnum
    func GetListVbsInstancesSortOrderEnumValues() []ListVbsInstancesSortOrderEnum
    func GetMappingListVbsInstancesSortOrderEnum(val string) (ListVbsInstancesSortOrderEnum, bool)
type ListWorkRequestErrorsRequest
    func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestErrorsRequest) String() string
    func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
type ListWorkRequestErrorsResponse
    func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestErrorsResponse) String() string
type ListWorkRequestErrorsSortByEnum
    func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
    func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
type ListWorkRequestErrorsSortOrderEnum
    func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
    func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
type ListWorkRequestLogsRequest
    func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestLogsRequest) String() string
    func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
type ListWorkRequestLogsResponse
    func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestLogsResponse) String() string
type ListWorkRequestLogsSortByEnum
    func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
    func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
type ListWorkRequestLogsSortOrderEnum
    func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
    func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
type ListWorkRequestsRequest
    func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestsRequest) String() string
    func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
type ListWorkRequestsResponse
    func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestsResponse) String() string
type ListWorkRequestsSortByEnum
    func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
    func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
type ListWorkRequestsSortOrderEnum
    func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
    func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
type OperationStatusEnum
    func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
    func GetOperationStatusEnumValues() []OperationStatusEnum
type OperationTypeEnum
    func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
    func GetOperationTypeEnumValues() []OperationTypeEnum
type SortOrderEnum
    func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
    func GetSortOrderEnumValues() []SortOrderEnum
type UpdateVbsInstanceDetails
    func (m UpdateVbsInstanceDetails) String() string
    func (m UpdateVbsInstanceDetails) ValidateEnumValue() (bool, error)
type UpdateVbsInstanceRequest
    func (request UpdateVbsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request UpdateVbsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request UpdateVbsInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateVbsInstanceRequest) String() string
    func (request UpdateVbsInstanceRequest) ValidateEnumValue() (bool, error)
type UpdateVbsInstanceResponse
    func (response UpdateVbsInstanceResponse) HTTPResponse() *http.Response
    func (response UpdateVbsInstanceResponse) String() string
type VbsInstance
    func (m VbsInstance) String() string
    func (m VbsInstance) ValidateEnumValue() (bool, error)
type VbsInstanceClient
    func NewVbsInstanceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client VbsInstanceClient, err error)
    func NewVbsInstanceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client VbsInstanceClient, err error)
    func (client VbsInstanceClient) ChangeVbsInstanceCompartment(ctx context.Context, request ChangeVbsInstanceCompartmentRequest) (response ChangeVbsInstanceCompartmentResponse, err error)
    func (client *VbsInstanceClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client VbsInstanceClient) CreateVbsInstance(ctx context.Context, request CreateVbsInstanceRequest) (response CreateVbsInstanceResponse, err error)
    func (client VbsInstanceClient) DeleteVbsInstance(ctx context.Context, request DeleteVbsInstanceRequest) (response DeleteVbsInstanceResponse, err error)
    func (client VbsInstanceClient) GetVbsInstance(ctx context.Context, request GetVbsInstanceRequest) (response GetVbsInstanceResponse, err error)
    func (client VbsInstanceClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
    func (client VbsInstanceClient) ListVbsInstances(ctx context.Context, request ListVbsInstancesRequest) (response ListVbsInstancesResponse, err error)
    func (client VbsInstanceClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
    func (client VbsInstanceClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
    func (client VbsInstanceClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
    func (client *VbsInstanceClient) SetRegion(region string)
    func (client VbsInstanceClient) UpdateVbsInstance(ctx context.Context, request UpdateVbsInstanceRequest) (response UpdateVbsInstanceResponse, err error)
type VbsInstanceSummary
    func (m VbsInstanceSummary) String() string
    func (m VbsInstanceSummary) ValidateEnumValue() (bool, error)
type VbsInstanceSummaryCollection
    func (m VbsInstanceSummaryCollection) String() string
    func (m VbsInstanceSummaryCollection) ValidateEnumValue() (bool, error)
type WorkRequest
    func (m WorkRequest) String() string
    func (m WorkRequest) ValidateEnumValue() (bool, error)
type WorkRequestError
    func (m WorkRequestError) String() string
    func (m WorkRequestError) ValidateEnumValue() (bool, error)
type WorkRequestErrorCollection
    func (m WorkRequestErrorCollection) String() string
    func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
type WorkRequestLogEntry
    func (m WorkRequestLogEntry) String() string
    func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
type WorkRequestLogEntryCollection
    func (m WorkRequestLogEntryCollection) String() string
    func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
type WorkRequestResource
    func (m WorkRequestResource) String() string
    func (m WorkRequestResource) ValidateEnumValue() (bool, error)
type WorkRequestSummary
    func (m WorkRequestSummary) String() string
    func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
type WorkRequestSummaryCollection
    func (m WorkRequestSummaryCollection) String() string
    func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)

Package files

action_type.go change_vbs_instance_compartment_details.go change_vbs_instance_compartment_request_response.go create_vbs_instance_details.go create_vbs_instance_request_response.go delete_vbs_instance_request_response.go get_vbs_instance_request_response.go get_work_request_request_response.go lifecycle_state.go list_vbs_instances_request_response.go list_work_request_errors_request_response.go list_work_request_logs_request_response.go list_work_requests_request_response.go operation_status.go operation_type.go sort_order.go update_vbs_instance_details.go update_vbs_instance_request_response.go vbs_instance.go vbs_instance_summary.go vbs_instance_summary_collection.go vbsinst_vbsinstance_client.go work_request.go work_request_error.go work_request_error_collection.go work_request_log_entry.go work_request_log_entry_collection.go work_request_resource.go work_request_summary.go work_request_summary_collection.go

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetLifecycleStateEnumStringValues

func GetLifecycleStateEnumStringValues() []string

GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum

func GetListVbsInstancesLifecycleStateEnumStringValues

func GetListVbsInstancesLifecycleStateEnumStringValues() []string

GetListVbsInstancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListVbsInstancesLifecycleStateEnum

func GetListVbsInstancesSortByEnumStringValues

func GetListVbsInstancesSortByEnumStringValues() []string

GetListVbsInstancesSortByEnumStringValues Enumerates the set of values in String for ListVbsInstancesSortByEnum

func GetListVbsInstancesSortOrderEnumStringValues

func GetListVbsInstancesSortOrderEnumStringValues() []string

GetListVbsInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListVbsInstancesSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

type ActionTypeEnum

ActionTypeEnum Enum with underlying type: string

type ActionTypeEnum string

Set of constants representing the allowable values for ActionTypeEnum

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

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type ChangeVbsInstanceCompartmentDetails

ChangeVbsInstanceCompartmentDetails The information to be updated.

type ChangeVbsInstanceCompartmentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
    // into which the resource should be moved.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

func (ChangeVbsInstanceCompartmentDetails) String

func (m ChangeVbsInstanceCompartmentDetails) String() string

func (ChangeVbsInstanceCompartmentDetails) ValidateEnumValue

func (m ChangeVbsInstanceCompartmentDetails) 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 ChangeVbsInstanceCompartmentRequest

ChangeVbsInstanceCompartmentRequest wrapper for the ChangeVbsInstanceCompartment operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/ChangeVbsInstanceCompartment.go.html to see an example of how to use ChangeVbsInstanceCompartmentRequest.

type ChangeVbsInstanceCompartmentRequest struct {

    // unique VbsInstance identifier
    VbsInstanceId *string `mandatory:"true" contributesTo:"path" name:"vbsInstanceId"`

    // The information to be updated.
    ChangeVbsInstanceCompartmentDetails `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 (ChangeVbsInstanceCompartmentRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeVbsInstanceCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeVbsInstanceCompartmentRequest) RetryPolicy

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

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

func (ChangeVbsInstanceCompartmentRequest) String

func (request ChangeVbsInstanceCompartmentRequest) String() string

func (ChangeVbsInstanceCompartmentRequest) ValidateEnumValue

func (request ChangeVbsInstanceCompartmentRequest) 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 ChangeVbsInstanceCompartmentResponse

ChangeVbsInstanceCompartmentResponse wrapper for the ChangeVbsInstanceCompartment operation

type ChangeVbsInstanceCompartmentResponse 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 (ChangeVbsInstanceCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeVbsInstanceCompartmentResponse) String

func (response ChangeVbsInstanceCompartmentResponse) String() string

type CreateVbsInstanceDetails

CreateVbsInstanceDetails The information about new VbsInstance.

type CreateVbsInstanceDetails struct {

    // Compartment Identifier
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Service Instance Name
    Name *string `mandatory:"true" json:"name"`

    // Display Name
    DisplayName *string `mandatory:"true" json:"displayName"`

    // Whether VBS is authorized to create and use resources in the customer tenancy
    IsResourceUsageAgreementGranted *bool `mandatory:"false" json:"isResourceUsageAgreementGranted"`

    // Compartment where VBS may create additional resources for the service instance
    ResourceCompartmentId *string `mandatory:"false" json:"resourceCompartmentId"`

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

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateVbsInstanceDetails) String

func (m CreateVbsInstanceDetails) String() string

func (CreateVbsInstanceDetails) ValidateEnumValue

func (m CreateVbsInstanceDetails) 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 CreateVbsInstanceRequest

CreateVbsInstanceRequest wrapper for the CreateVbsInstance operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/CreateVbsInstance.go.html to see an example of how to use CreateVbsInstanceRequest.

type CreateVbsInstanceRequest struct {

    // Details for the new VbsInstance.
    CreateVbsInstanceDetails `contributesTo:"body"`

    // IDCS personal acceess token identifying IDCS user and stripe for the VBS service
    IdcsAccessToken *string `mandatory:"false" contributesTo:"header" name:"idcs-access-token"`

    // 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 (CreateVbsInstanceRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateVbsInstanceRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateVbsInstanceRequest) RetryPolicy

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

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

func (CreateVbsInstanceRequest) String

func (request CreateVbsInstanceRequest) String() string

func (CreateVbsInstanceRequest) ValidateEnumValue

func (request CreateVbsInstanceRequest) 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 CreateVbsInstanceResponse

CreateVbsInstanceResponse wrapper for the CreateVbsInstance operation

type CreateVbsInstanceResponse 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 (CreateVbsInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateVbsInstanceResponse) String

func (response CreateVbsInstanceResponse) String() string

type DeleteVbsInstanceRequest

DeleteVbsInstanceRequest wrapper for the DeleteVbsInstance operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/DeleteVbsInstance.go.html to see an example of how to use DeleteVbsInstanceRequest.

type DeleteVbsInstanceRequest struct {

    // unique VbsInstance identifier
    VbsInstanceId *string `mandatory:"true" contributesTo:"path" name:"vbsInstanceId"`

    // 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 (DeleteVbsInstanceRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteVbsInstanceRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteVbsInstanceRequest) RetryPolicy

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

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

func (DeleteVbsInstanceRequest) String

func (request DeleteVbsInstanceRequest) String() string

func (DeleteVbsInstanceRequest) ValidateEnumValue

func (request DeleteVbsInstanceRequest) 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 DeleteVbsInstanceResponse

DeleteVbsInstanceResponse wrapper for the DeleteVbsInstance operation

type DeleteVbsInstanceResponse 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 (DeleteVbsInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteVbsInstanceResponse) String

func (response DeleteVbsInstanceResponse) String() string

type GetVbsInstanceRequest

GetVbsInstanceRequest wrapper for the GetVbsInstance operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/GetVbsInstance.go.html to see an example of how to use GetVbsInstanceRequest.

type GetVbsInstanceRequest struct {

    // unique VbsInstance identifier
    VbsInstanceId *string `mandatory:"true" contributesTo:"path" name:"vbsInstanceId"`

    // 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 (GetVbsInstanceRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetVbsInstanceRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetVbsInstanceRequest) RetryPolicy

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

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

func (GetVbsInstanceRequest) String

func (request GetVbsInstanceRequest) String() string

func (GetVbsInstanceRequest) ValidateEnumValue

func (request GetVbsInstanceRequest) 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 GetVbsInstanceResponse

GetVbsInstanceResponse wrapper for the GetVbsInstance operation

type GetVbsInstanceResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The VbsInstance instance
    VbsInstance `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 (GetVbsInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetVbsInstanceResponse) String

func (response GetVbsInstanceResponse) 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/65.59.0/vbsinst/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) 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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

type GetWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The WorkRequest instance
    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"`

    // A 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 LifecycleStateEnum

LifecycleStateEnum Enum with underlying type: string

type LifecycleStateEnum string

Set of constants representing the allowable values for LifecycleStateEnum

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

func GetLifecycleStateEnumValues

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 ListVbsInstancesLifecycleStateEnum

ListVbsInstancesLifecycleStateEnum Enum with underlying type: string

type ListVbsInstancesLifecycleStateEnum string

Set of constants representing the allowable values for ListVbsInstancesLifecycleStateEnum

const (
    ListVbsInstancesLifecycleStateCreating ListVbsInstancesLifecycleStateEnum = "CREATING"
    ListVbsInstancesLifecycleStateUpdating ListVbsInstancesLifecycleStateEnum = "UPDATING"
    ListVbsInstancesLifecycleStateActive   ListVbsInstancesLifecycleStateEnum = "ACTIVE"
    ListVbsInstancesLifecycleStateDeleting ListVbsInstancesLifecycleStateEnum = "DELETING"
    ListVbsInstancesLifecycleStateDeleted  ListVbsInstancesLifecycleStateEnum = "DELETED"
    ListVbsInstancesLifecycleStateFailed   ListVbsInstancesLifecycleStateEnum = "FAILED"
)

func GetListVbsInstancesLifecycleStateEnumValues

func GetListVbsInstancesLifecycleStateEnumValues() []ListVbsInstancesLifecycleStateEnum

GetListVbsInstancesLifecycleStateEnumValues Enumerates the set of values for ListVbsInstancesLifecycleStateEnum

func GetMappingListVbsInstancesLifecycleStateEnum

func GetMappingListVbsInstancesLifecycleStateEnum(val string) (ListVbsInstancesLifecycleStateEnum, bool)

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

type ListVbsInstancesRequest

ListVbsInstancesRequest wrapper for the ListVbsInstances operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/ListVbsInstances.go.html to see an example of how to use ListVbsInstancesRequest.

type ListVbsInstancesRequest struct {

    // The ID of the compartment in which to list resources.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // A filter to return only resources their lifecycleState matches the given lifecycleState.
    LifecycleState ListVbsInstancesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // unique VbsInstance identifier
    Id *string `mandatory:"false" contributesTo:"query" name:"id"`

    // A filter to return only resources that match the entire name given.
    Name *string `mandatory:"false" contributesTo:"query" name:"name"`

    // 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 ListVbsInstancesSortOrderEnum `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 ListVbsInstancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" 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 (ListVbsInstancesRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListVbsInstancesRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListVbsInstancesRequest) RetryPolicy

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

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

func (ListVbsInstancesRequest) String

func (request ListVbsInstancesRequest) String() string

func (ListVbsInstancesRequest) ValidateEnumValue

func (request ListVbsInstancesRequest) 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 ListVbsInstancesResponse

ListVbsInstancesResponse wrapper for the ListVbsInstances operation

type ListVbsInstancesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of VbsInstanceSummaryCollection instances
    VbsInstanceSummaryCollection `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 (ListVbsInstancesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListVbsInstancesResponse) String

func (response ListVbsInstancesResponse) String() string

type ListVbsInstancesSortByEnum

ListVbsInstancesSortByEnum Enum with underlying type: string

type ListVbsInstancesSortByEnum string

Set of constants representing the allowable values for ListVbsInstancesSortByEnum

const (
    ListVbsInstancesSortByTimecreated ListVbsInstancesSortByEnum = "timeCreated"
    ListVbsInstancesSortByDisplayname ListVbsInstancesSortByEnum = "displayName"
)

func GetListVbsInstancesSortByEnumValues

func GetListVbsInstancesSortByEnumValues() []ListVbsInstancesSortByEnum

GetListVbsInstancesSortByEnumValues Enumerates the set of values for ListVbsInstancesSortByEnum

func GetMappingListVbsInstancesSortByEnum

func GetMappingListVbsInstancesSortByEnum(val string) (ListVbsInstancesSortByEnum, bool)

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

type ListVbsInstancesSortOrderEnum

ListVbsInstancesSortOrderEnum Enum with underlying type: string

type ListVbsInstancesSortOrderEnum string

Set of constants representing the allowable values for ListVbsInstancesSortOrderEnum

const (
    ListVbsInstancesSortOrderAsc  ListVbsInstancesSortOrderEnum = "ASC"
    ListVbsInstancesSortOrderDesc ListVbsInstancesSortOrderEnum = "DESC"
)

func GetListVbsInstancesSortOrderEnumValues

func GetListVbsInstancesSortOrderEnumValues() []ListVbsInstancesSortOrderEnum

GetListVbsInstancesSortOrderEnumValues Enumerates the set of values for ListVbsInstancesSortOrderEnum

func GetMappingListVbsInstancesSortOrderEnum

func GetMappingListVbsInstancesSortOrderEnum(val string) (ListVbsInstancesSortOrderEnum, bool)

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

type ListWorkRequestErrorsRequest

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

# See also

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

    // The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
    SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either 'asc' or 'desc'.
    SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

type ListWorkRequestErrorsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

    // 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 ListWorkRequestErrorsSortByEnum

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

type ListWorkRequestErrorsSortByEnum string

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

const (
    ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

type ListWorkRequestErrorsSortOrderEnum string

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

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

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

# See also

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

    // The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
    SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either 'asc' or 'desc'.
    SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

type ListWorkRequestLogsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

    // 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 ListWorkRequestLogsSortByEnum

ListWorkRequestLogsSortByEnum Enum with underlying type: string

type ListWorkRequestLogsSortByEnum string

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

const (
    ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

type ListWorkRequestLogsSortOrderEnum string

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

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

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/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 ID of the asynchronous work request.
    WorkRequestId *string `mandatory:"false" contributesTo:"query" 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"`

    // The sort order to use, either 'asc' or 'desc'.
    SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
    SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

type ListWorkRequestsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // For 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 ListWorkRequestsSortByEnum

ListWorkRequestsSortByEnum Enum with underlying type: string

type ListWorkRequestsSortByEnum string

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

const (
    ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum

ListWorkRequestsSortOrderEnum Enum with underlying type: string

type ListWorkRequestsSortOrderEnum string

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

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

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type OperationStatusEnum

OperationStatusEnum Enum with underlying type: string

type OperationStatusEnum string

Set of constants representing the allowable values for OperationStatusEnum

const (
    OperationStatusAccepted   OperationStatusEnum = "ACCEPTED"
    OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
    OperationStatusFailed     OperationStatusEnum = "FAILED"
    OperationStatusSucceeded  OperationStatusEnum = "SUCCEEDED"
    OperationStatusCanceling  OperationStatusEnum = "CANCELING"
    OperationStatusCanceled   OperationStatusEnum = "CANCELED"
)

func GetMappingOperationStatusEnum

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

OperationTypeEnum Enum with underlying type: string

type OperationTypeEnum string

Set of constants representing the allowable values for OperationTypeEnum

const (
    OperationTypeCreateVbsInstance OperationTypeEnum = "CREATE_VBS_INSTANCE"
    OperationTypeUpdateVbsInstance OperationTypeEnum = "UPDATE_VBS_INSTANCE"
    OperationTypeDeleteVbsInstance OperationTypeEnum = "DELETE_VBS_INSTANCE"
    OperationTypeMoveVbsInstance   OperationTypeEnum = "MOVE_VBS_INSTANCE"
)

func GetMappingOperationTypeEnum

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type SortOrderEnum

SortOrderEnum Enum with underlying type: string

type SortOrderEnum string

Set of constants representing the allowable values for SortOrderEnum

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

func GetMappingSortOrderEnum

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type UpdateVbsInstanceDetails

UpdateVbsInstanceDetails The information to be updated.

type UpdateVbsInstanceDetails struct {

    // Display Name
    DisplayName *string `mandatory:"true" json:"displayName"`

    // Whether VBS is authorized to create and use resources in the customer tenancy
    IsResourceUsageAgreementGranted *bool `mandatory:"false" json:"isResourceUsageAgreementGranted"`

    // Compartment where VBS may create additional resources for the service instance
    ResourceCompartmentId *string `mandatory:"false" json:"resourceCompartmentId"`

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

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateVbsInstanceDetails) String

func (m UpdateVbsInstanceDetails) String() string

func (UpdateVbsInstanceDetails) ValidateEnumValue

func (m UpdateVbsInstanceDetails) 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 UpdateVbsInstanceRequest

UpdateVbsInstanceRequest wrapper for the UpdateVbsInstance operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/UpdateVbsInstance.go.html to see an example of how to use UpdateVbsInstanceRequest.

type UpdateVbsInstanceRequest struct {

    // unique VbsInstance identifier
    VbsInstanceId *string `mandatory:"true" contributesTo:"path" name:"vbsInstanceId"`

    // The information to be updated.
    UpdateVbsInstanceDetails `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 (UpdateVbsInstanceRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateVbsInstanceRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateVbsInstanceRequest) RetryPolicy

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

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

func (UpdateVbsInstanceRequest) String

func (request UpdateVbsInstanceRequest) String() string

func (UpdateVbsInstanceRequest) ValidateEnumValue

func (request UpdateVbsInstanceRequest) 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 UpdateVbsInstanceResponse

UpdateVbsInstanceResponse wrapper for the UpdateVbsInstance operation

type UpdateVbsInstanceResponse 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 (UpdateVbsInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateVbsInstanceResponse) String

func (response UpdateVbsInstanceResponse) String() string

type VbsInstance

VbsInstance Visual Builder Studio service instance

type VbsInstance struct {

    // Unique identifier that is immutable on creation
    Id *string `mandatory:"true" json:"id"`

    // Service instance name (unique identifier)
    Name *string `mandatory:"true" json:"name"`

    // Service instance display name
    DisplayName *string `mandatory:"true" json:"displayName"`

    // Compartment of the service instance
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
    IsResourceUsageAgreementGranted *bool `mandatory:"false" json:"isResourceUsageAgreementGranted"`

    // Compartment where VBS may create additional resources for the service instance
    ResourceCompartmentId *string `mandatory:"false" json:"resourceCompartmentId"`

    // Public web URL for accessing the VBS service instance
    VbsAccessUrl *string `mandatory:"false" json:"vbsAccessUrl"`

    // The time the the VbsInstance was created. An RFC3339 formatted datetime string
    TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

    // The time the VbsInstance was updated. An RFC3339 formatted datetime string
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

    // The current state of the VbsInstance.
    LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    LifecyleDetails *string `mandatory:"false" json:"lifecyleDetails"`

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

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Usage of system tag keys. These predefined keys are scoped to namespaces.
    // Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (VbsInstance) String

func (m VbsInstance) String() string

func (VbsInstance) ValidateEnumValue

func (m VbsInstance) 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 VbsInstanceClient

VbsInstanceClient a client for VbsInstance

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

func NewVbsInstanceClientWithConfigurationProvider

func NewVbsInstanceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client VbsInstanceClient, err error)

NewVbsInstanceClientWithConfigurationProvider Creates a new default VbsInstance client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewVbsInstanceClientWithOboToken

func NewVbsInstanceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client VbsInstanceClient, err error)

NewVbsInstanceClientWithOboToken Creates a new default VbsInstance 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 (VbsInstanceClient) ChangeVbsInstanceCompartment

func (client VbsInstanceClient) ChangeVbsInstanceCompartment(ctx context.Context, request ChangeVbsInstanceCompartmentRequest) (response ChangeVbsInstanceCompartmentResponse, err error)

ChangeVbsInstanceCompartment Moves a VbsInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/ChangeVbsInstanceCompartment.go.html to see an example of how to use ChangeVbsInstanceCompartment API.

func (*VbsInstanceClient) ConfigurationProvider

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

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

func (VbsInstanceClient) CreateVbsInstance

func (client VbsInstanceClient) CreateVbsInstance(ctx context.Context, request CreateVbsInstanceRequest) (response CreateVbsInstanceResponse, err error)

CreateVbsInstance Creates a new VbsInstance.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/CreateVbsInstance.go.html to see an example of how to use CreateVbsInstance API.

func (VbsInstanceClient) DeleteVbsInstance

func (client VbsInstanceClient) DeleteVbsInstance(ctx context.Context, request DeleteVbsInstanceRequest) (response DeleteVbsInstanceResponse, err error)

DeleteVbsInstance Deletes a VbsInstance resource by identifier

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/DeleteVbsInstance.go.html to see an example of how to use DeleteVbsInstance API.

func (VbsInstanceClient) GetVbsInstance

func (client VbsInstanceClient) GetVbsInstance(ctx context.Context, request GetVbsInstanceRequest) (response GetVbsInstanceResponse, err error)

GetVbsInstance Gets a VbsInstance by identifier

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/GetVbsInstance.go.html to see an example of how to use GetVbsInstance API.

func (VbsInstanceClient) GetWorkRequest

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

GetWorkRequest Gets the status of the work request with the given ID.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.

func (VbsInstanceClient) ListVbsInstances

func (client VbsInstanceClient) ListVbsInstances(ctx context.Context, request ListVbsInstancesRequest) (response ListVbsInstancesResponse, err error)

ListVbsInstances Returns a list of VbsInstances.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/ListVbsInstances.go.html to see an example of how to use ListVbsInstances API.

func (VbsInstanceClient) ListWorkRequestErrors

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

ListWorkRequestErrors Return a (paginated) list of errors for a given work request.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.

func (VbsInstanceClient) ListWorkRequestLogs

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

ListWorkRequestLogs Return a (paginated) list of logs for a given work request.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.

func (VbsInstanceClient) ListWorkRequests

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

ListWorkRequests Lists the work requests in a compartment.

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.

func (*VbsInstanceClient) SetRegion

func (client *VbsInstanceClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (VbsInstanceClient) UpdateVbsInstance

func (client VbsInstanceClient) UpdateVbsInstance(ctx context.Context, request UpdateVbsInstanceRequest) (response UpdateVbsInstanceResponse, err error)

UpdateVbsInstance Updates the VbsInstance

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/vbsinst/UpdateVbsInstance.go.html to see an example of how to use UpdateVbsInstance API.

type VbsInstanceSummary

VbsInstanceSummary Summary of the Visual Builder Studio service instance

type VbsInstanceSummary struct {

    // Unique identifier that is immutable on creation
    Id *string `mandatory:"true" json:"id"`

    // Service instance name (unique identifier)
    Name *string `mandatory:"true" json:"name"`

    // Service instance display name
    DisplayName *string `mandatory:"true" json:"displayName"`

    // Compartment of the service instance
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
    IsResourceUsageAgreementGranted *bool `mandatory:"false" json:"isResourceUsageAgreementGranted"`

    // The time the the VbsInstance was created. An RFC3339 formatted datetime string
    TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

    // The time the VbsInstance was updated. An RFC3339 formatted datetime string
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

    // The current state of the VbsInstance.
    LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

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

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Usage of system tag keys. These predefined keys are scoped to namespaces.
    // Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (VbsInstanceSummary) String

func (m VbsInstanceSummary) String() string

func (VbsInstanceSummary) ValidateEnumValue

func (m VbsInstanceSummary) 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 VbsInstanceSummaryCollection

VbsInstanceSummaryCollection Wrapped list of Visual Builder Studio service instances

type VbsInstanceSummaryCollection struct {

    // The Visual Builder Studio service instances
    Items []VbsInstanceSummary `mandatory:"true" json:"items"`
}

func (VbsInstanceSummaryCollection) String

func (m VbsInstanceSummaryCollection) String() string

func (VbsInstanceSummaryCollection) ValidateEnumValue

func (m VbsInstanceSummaryCollection) 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 WorkRequest

WorkRequest A VBS Instance related work request

type WorkRequest struct {

    // Type of the work request
    OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

    // Status of current work request.
    Status OperationStatusEnum `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"`

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

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

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

func (WorkRequestError) ValidateEnumValue

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

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

type WorkRequestErrorCollection

WorkRequestErrorCollection A list of errors encountered while executing a work request.

type WorkRequestErrorCollection struct {

    // The errors.
    Items []WorkRequestError `mandatory:"true" json:"items"`
}

func (WorkRequestErrorCollection) String

func (m WorkRequestErrorCollection) String() string

func (WorkRequestErrorCollection) ValidateEnumValue

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

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

type WorkRequestLogEntry

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

func (WorkRequestLogEntry) ValidateEnumValue

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

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

type WorkRequestLogEntryCollection

WorkRequestLogEntryCollection A list of log messages from the execution of a work request.

type WorkRequestLogEntryCollection struct {

    // The log messages.
    Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

func (WorkRequestLogEntryCollection) String

func (m WorkRequestLogEntryCollection) String() string

func (WorkRequestLogEntryCollection) ValidateEnumValue

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

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

type WorkRequestResource

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

type WorkRequestResource struct {

    // The resource type the work request 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 ActionTypeEnum `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

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 WorkRequestSummary

WorkRequestSummary A summary of the status of a work request.

type WorkRequestSummary struct {

    // Type of the work request
    OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

    // Status of current work request.
    Status OperationStatusEnum `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"`

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

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

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

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

type WorkRequestSummaryCollection

WorkRequestSummaryCollection A list of VBS instance related work requests.

type WorkRequestSummaryCollection struct {

    // List of workRequestSummary objects.
    Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

func (WorkRequestSummaryCollection) String

func (m WorkRequestSummaryCollection) String() string

func (WorkRequestSummaryCollection) ValidateEnumValue

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

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