func GetApplicationSummaryStateEnumStringValues() []string
GetApplicationSummaryStateEnumStringValues Enumerates the set of values in String for ApplicationSummaryStateEnum
func GetAttachmentDetailsTargetRoleEnumStringValues() []string
GetAttachmentDetailsTargetRoleEnumStringValues Enumerates the set of values in String for AttachmentDetailsTargetRoleEnum
func GetCreateVbInstanceDetailsConsumptionModelEnumStringValues() []string
GetCreateVbInstanceDetailsConsumptionModelEnumStringValues Enumerates the set of values in String for CreateVbInstanceDetailsConsumptionModelEnum
func GetListVbInstancesLifecycleStateEnumStringValues() []string
GetListVbInstancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListVbInstancesLifecycleStateEnum
func GetListVbInstancesSortByEnumStringValues() []string
GetListVbInstancesSortByEnumStringValues Enumerates the set of values in String for ListVbInstancesSortByEnum
func GetListVbInstancesSortOrderEnumStringValues() []string
GetListVbInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListVbInstancesSortOrderEnum
func GetVbInstanceConsumptionModelEnumStringValues() []string
GetVbInstanceConsumptionModelEnumStringValues Enumerates the set of values in String for VbInstanceConsumptionModelEnum
func GetVbInstanceLifecycleStateEnumStringValues() []string
GetVbInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for VbInstanceLifecycleStateEnum
func GetVbInstanceSummaryConsumptionModelEnumStringValues() []string
GetVbInstanceSummaryConsumptionModelEnumStringValues Enumerates the set of values in String for VbInstanceSummaryConsumptionModelEnum
func GetVbInstanceSummaryLifecycleStateEnumStringValues() []string
GetVbInstanceSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for VbInstanceSummaryLifecycleStateEnum
func GetWorkRequestOperationTypeEnumStringValues() []string
GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum
func GetWorkRequestResourceActionTypeEnumStringValues() []string
GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum
func GetWorkRequestStatusEnumStringValues() []string
GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum
func GetWorkRequestSummaryOperationTypeEnumStringValues() []string
GetWorkRequestSummaryOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestSummaryOperationTypeEnum
func GetWorkRequestSummaryStatusEnumStringValues() []string
GetWorkRequestSummaryStatusEnumStringValues Enumerates the set of values in String for WorkRequestSummaryStatusEnum
ApplicationSummary Summary of the Vb Instance's applications.
type ApplicationSummary struct {
// Unique identifier of the application.
Id *string `mandatory:"true" json:"id"`
// Project identifier.
ProjectId *string `mandatory:"true" json:"projectId"`
// Version of deployed application.
Version *string `mandatory:"true" json:"version"`
// Represents the deployment state of the application.
State ApplicationSummaryStateEnum `mandatory:"true" json:"state"`
}
func (m ApplicationSummary) String() string
func (m ApplicationSummary) 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
ApplicationSummaryCollection Result of listing VbInstance's applications. Contains ApplicationSummary items.
type ApplicationSummaryCollection struct {
// The collection of ApplicationSummary objects.
Items []ApplicationSummary `mandatory:"true" json:"items"`
}
func (m ApplicationSummaryCollection) String() string
func (m ApplicationSummaryCollection) 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
ApplicationSummaryStateEnum Enum with underlying type: string
type ApplicationSummaryStateEnum string
Set of constants representing the allowable values for ApplicationSummaryStateEnum
const (
ApplicationSummaryStateStage ApplicationSummaryStateEnum = "STAGE"
ApplicationSummaryStateLive ApplicationSummaryStateEnum = "LIVE"
)
func GetApplicationSummaryStateEnumValues() []ApplicationSummaryStateEnum
GetApplicationSummaryStateEnumValues Enumerates the set of values for ApplicationSummaryStateEnum
func GetMappingApplicationSummaryStateEnum(val string) (ApplicationSummaryStateEnum, bool)
GetMappingApplicationSummaryStateEnum performs case Insensitive comparison on enum value and return the desired enum
AttachmentDetails Description of an attachments for this instance
type AttachmentDetails struct {
// The role of the target attachment.
// * `PARENT` - The target instance is the parent of this attachment.
// * `CHILD` - The target instance is the child of this attachment.
TargetRole AttachmentDetailsTargetRoleEnum `mandatory:"true" json:"targetRole"`
// * If role == `PARENT`, the attached instance was created by this service instance
// * If role == `CHILD`, this instance was created from attached instance on behalf of a user
IsImplicit *bool `mandatory:"true" json:"isImplicit"`
// The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which this instance is attached.
TargetId *string `mandatory:"true" json:"targetId"`
// The dataplane instance URL of the attached instance
TargetInstanceUrl *string `mandatory:"true" json:"targetInstanceUrl"`
// The type of the target instance, such as "FUSION".
TargetServiceType *string `mandatory:"true" json:"targetServiceType"`
}
func (m AttachmentDetails) String() string
func (m AttachmentDetails) 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
AttachmentDetailsTargetRoleEnum Enum with underlying type: string
type AttachmentDetailsTargetRoleEnum string
Set of constants representing the allowable values for AttachmentDetailsTargetRoleEnum
const (
AttachmentDetailsTargetRoleParent AttachmentDetailsTargetRoleEnum = "PARENT"
AttachmentDetailsTargetRoleChild AttachmentDetailsTargetRoleEnum = "CHILD"
)
func GetAttachmentDetailsTargetRoleEnumValues() []AttachmentDetailsTargetRoleEnum
GetAttachmentDetailsTargetRoleEnumValues Enumerates the set of values for AttachmentDetailsTargetRoleEnum
func GetMappingAttachmentDetailsTargetRoleEnum(val string) (AttachmentDetailsTargetRoleEnum, bool)
GetMappingAttachmentDetailsTargetRoleEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeVbInstanceCompartmentDetails Compartment the VbInstance will be moved to
type ChangeVbInstanceCompartmentDetails struct {
// Compartment Identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeVbInstanceCompartmentDetails) String() string
func (m ChangeVbInstanceCompartmentDetails) 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
ChangeVbInstanceCompartmentRequest wrapper for the ChangeVbInstanceCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/ChangeVbInstanceCompartment.go.html to see an example of how to use ChangeVbInstanceCompartmentRequest.
type ChangeVbInstanceCompartmentRequest struct {
// Unique Vb Instance identifier.
VbInstanceId *string `mandatory:"true" contributesTo:"path" name:"vbInstanceId"`
// Details for the update vb instance
ChangeVbInstanceCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated before
// then due to conflicting operations. For example, if a resource has been
// deleted and purged from the system, then a retry of the original creation
// request might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeVbInstanceCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeVbInstanceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeVbInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeVbInstanceCompartmentRequest) String() string
func (request ChangeVbInstanceCompartmentRequest) 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
ChangeVbInstanceCompartmentResponse wrapper for the ChangeVbInstanceCompartment operation
type ChangeVbInstanceCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request.
// You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeVbInstanceCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeVbInstanceCompartmentResponse) String() string
CreateCustomEndpointDetails Details for a custom endpoint for the vb instance (update).
type CreateCustomEndpointDetails struct {
// A custom hostname to be used for the vb instance URL, in FQDN format.
Hostname *string `mandatory:"true" json:"hostname"`
// Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
// All certificates should be stored in a single base64 encoded secret
// Note the update will fail if this is not a valid certificate.
CertificateSecretId *string `mandatory:"false" json:"certificateSecretId"`
}
func (m CreateCustomEndpointDetails) String() string
func (m CreateCustomEndpointDetails) 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
CreateVbInstanceDetails The information about new VbInstance.
type CreateVbInstanceDetails struct {
// Vb Instance Identifier.
DisplayName *string `mandatory:"true" json:"displayName"`
// Compartment Identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The number of Nodes
NodeCount *int `mandatory:"true" json:"nodeCount"`
// 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"`
// Encrypted IDCS Open ID token. This is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required parameter
IdcsOpenId *string `mandatory:"false" json:"idcsOpenId"`
// Visual Builder is enabled or not.
IsVisualBuilderEnabled *bool `mandatory:"false" json:"isVisualBuilderEnabled"`
CustomEndpoint *CreateCustomEndpointDetails `mandatory:"false" json:"customEndpoint"`
// A list of alternate custom endpoints to be used for the vb instance URL
// (contact Oracle for alternateCustomEndpoints availability for a specific instance).
AlternateCustomEndpoints []CreateCustomEndpointDetails `mandatory:"false" json:"alternateCustomEndpoints"`
// Optional parameter specifying which entitlement to use for billing purposes. Only required if the account possesses more than one entitlement.
ConsumptionModel CreateVbInstanceDetailsConsumptionModelEnum `mandatory:"false" json:"consumptionModel,omitempty"`
}
func (m CreateVbInstanceDetails) String() string
func (m CreateVbInstanceDetails) 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
CreateVbInstanceDetailsConsumptionModelEnum Enum with underlying type: string
type CreateVbInstanceDetailsConsumptionModelEnum string
Set of constants representing the allowable values for CreateVbInstanceDetailsConsumptionModelEnum
const (
CreateVbInstanceDetailsConsumptionModelUcm CreateVbInstanceDetailsConsumptionModelEnum = "UCM"
CreateVbInstanceDetailsConsumptionModelGov CreateVbInstanceDetailsConsumptionModelEnum = "GOV"
CreateVbInstanceDetailsConsumptionModelVb4saas CreateVbInstanceDetailsConsumptionModelEnum = "VB4SAAS"
)
func GetCreateVbInstanceDetailsConsumptionModelEnumValues() []CreateVbInstanceDetailsConsumptionModelEnum
GetCreateVbInstanceDetailsConsumptionModelEnumValues Enumerates the set of values for CreateVbInstanceDetailsConsumptionModelEnum
func GetMappingCreateVbInstanceDetailsConsumptionModelEnum(val string) (CreateVbInstanceDetailsConsumptionModelEnum, bool)
GetMappingCreateVbInstanceDetailsConsumptionModelEnum performs case Insensitive comparison on enum value and return the desired enum
CreateVbInstanceRequest wrapper for the CreateVbInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/CreateVbInstance.go.html to see an example of how to use CreateVbInstanceRequest.
type CreateVbInstanceRequest struct {
// Details for the new Vb Instance.
CreateVbInstanceDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated before
// then due to conflicting operations. For example, if a resource has been
// deleted and purged from the system, then a retry of the original creation
// request might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateVbInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateVbInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateVbInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateVbInstanceRequest) String() string
func (request CreateVbInstanceRequest) 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
CreateVbInstanceResponse wrapper for the CreateVbInstance operation
type CreateVbInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request.
// You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateVbInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateVbInstanceResponse) String() string
CustomEndpointDetails Details for a custom endpoint for the vb instance.
type CustomEndpointDetails struct {
// A custom hostname to be used for the vb instance URL, in FQDN format.
Hostname *string `mandatory:"true" json:"hostname"`
// Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
CertificateSecretId *string `mandatory:"false" json:"certificateSecretId"`
// The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
CertificateSecretVersion *int `mandatory:"false" json:"certificateSecretVersion"`
}
func (m CustomEndpointDetails) String() string
func (m CustomEndpointDetails) 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
DeleteVbInstanceRequest wrapper for the DeleteVbInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/DeleteVbInstance.go.html to see an example of how to use DeleteVbInstanceRequest.
type DeleteVbInstanceRequest struct {
// Unique Vb Instance identifier.
VbInstanceId *string `mandatory:"true" contributesTo:"path" name:"vbInstanceId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteVbInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteVbInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteVbInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteVbInstanceRequest) String() string
func (request DeleteVbInstanceRequest) 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
DeleteVbInstanceResponse wrapper for the DeleteVbInstance operation
type DeleteVbInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request.
// You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteVbInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteVbInstanceResponse) String() string
GetVbInstanceRequest wrapper for the GetVbInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/GetVbInstance.go.html to see an example of how to use GetVbInstanceRequest.
type GetVbInstanceRequest struct {
// Unique Vb Instance identifier.
VbInstanceId *string `mandatory:"true" contributesTo:"path" name:"vbInstanceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetVbInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetVbInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetVbInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetVbInstanceRequest) String() string
func (request GetVbInstanceRequest) 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
GetVbInstanceResponse wrapper for the GetVbInstance operation
type GetVbInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The VbInstance instance
VbInstance `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetVbInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetVbInstanceResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// some decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
IdcsInfoDetails Information for IDCS access
type IdcsInfoDetails struct {
// URL for the location of the IDCS Application (used by IDCS APIs)
IdcsAppLocationUrl *string `mandatory:"true" json:"idcsAppLocationUrl"`
// The IDCS application display name associated with the instance
IdcsAppDisplayName *string `mandatory:"true" json:"idcsAppDisplayName"`
// The IDCS application ID associated with the instance
IdcsAppId *string `mandatory:"true" json:"idcsAppId"`
// The IDCS application name associated with the instance
IdcsAppName *string `mandatory:"true" json:"idcsAppName"`
// The URL used as the primary audience for visual builder flows in this instance
// type: string
InstancePrimaryAudienceUrl *string `mandatory:"true" json:"instancePrimaryAudienceUrl"`
}
func (m IdcsInfoDetails) String() string
func (m IdcsInfoDetails) 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
ListVbInstancesLifecycleStateEnum Enum with underlying type: string
type ListVbInstancesLifecycleStateEnum string
Set of constants representing the allowable values for ListVbInstancesLifecycleStateEnum
const (
ListVbInstancesLifecycleStateCreating ListVbInstancesLifecycleStateEnum = "CREATING"
ListVbInstancesLifecycleStateUpdating ListVbInstancesLifecycleStateEnum = "UPDATING"
ListVbInstancesLifecycleStateActive ListVbInstancesLifecycleStateEnum = "ACTIVE"
ListVbInstancesLifecycleStateInactive ListVbInstancesLifecycleStateEnum = "INACTIVE"
ListVbInstancesLifecycleStateDeleting ListVbInstancesLifecycleStateEnum = "DELETING"
ListVbInstancesLifecycleStateDeleted ListVbInstancesLifecycleStateEnum = "DELETED"
ListVbInstancesLifecycleStateFailed ListVbInstancesLifecycleStateEnum = "FAILED"
)
func GetListVbInstancesLifecycleStateEnumValues() []ListVbInstancesLifecycleStateEnum
GetListVbInstancesLifecycleStateEnumValues Enumerates the set of values for ListVbInstancesLifecycleStateEnum
func GetMappingListVbInstancesLifecycleStateEnum(val string) (ListVbInstancesLifecycleStateEnum, bool)
GetMappingListVbInstancesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListVbInstancesRequest wrapper for the ListVbInstances operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/ListVbInstances.go.html to see an example of how to use ListVbInstancesRequest.
type ListVbInstancesRequest 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"`
// Life cycle state to query on.
LifecycleState ListVbInstancesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// 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 ListVbInstancesSortOrderEnum `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 ListVbInstancesSortByEnum `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 (request ListVbInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListVbInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListVbInstancesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVbInstancesRequest) String() string
func (request ListVbInstancesRequest) 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
ListVbInstancesResponse wrapper for the ListVbInstances operation
type ListVbInstancesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of VbInstanceSummaryCollection instances
VbInstanceSummaryCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, additional pages of results have been previously returned
OpcPreviousPage *string `presentIn:"header" name:"opc-previous-page"`
}
func (response ListVbInstancesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListVbInstancesResponse) String() string
ListVbInstancesSortByEnum Enum with underlying type: string
type ListVbInstancesSortByEnum string
Set of constants representing the allowable values for ListVbInstancesSortByEnum
const (
ListVbInstancesSortByTimecreated ListVbInstancesSortByEnum = "timeCreated"
ListVbInstancesSortByDisplayname ListVbInstancesSortByEnum = "displayName"
)
func GetListVbInstancesSortByEnumValues() []ListVbInstancesSortByEnum
GetListVbInstancesSortByEnumValues Enumerates the set of values for ListVbInstancesSortByEnum
func GetMappingListVbInstancesSortByEnum(val string) (ListVbInstancesSortByEnum, bool)
GetMappingListVbInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListVbInstancesSortOrderEnum Enum with underlying type: string
type ListVbInstancesSortOrderEnum string
Set of constants representing the allowable values for ListVbInstancesSortOrderEnum
const (
ListVbInstancesSortOrderAsc ListVbInstancesSortOrderEnum = "ASC"
ListVbInstancesSortOrderDesc ListVbInstancesSortOrderEnum = "DESC"
)
func GetListVbInstancesSortOrderEnumValues() []ListVbInstancesSortOrderEnum
GetListVbInstancesSortOrderEnumValues Enumerates the set of values for ListVbInstancesSortOrderEnum
func GetMappingListVbInstancesSortOrderEnum(val string) (ListVbInstancesSortOrderEnum, bool)
GetMappingListVbInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, additional pages of results have been previously returned
OpcPreviousPage *string `presentIn:"header" name:"opc-previous-page"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, additional pages of results have been previously returned
OpcPreviousPage *string `presentIn:"header" name:"opc-previous-page"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/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 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 Vb Instance identifier to use to filter results
VbInstanceId *string `mandatory:"false" contributesTo:"query" name:"vbInstanceId"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, additional pages of results have been previously returned
OpcPreviousPage *string `presentIn:"header" name:"opc-previous-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
RequestSummarizedApplicationsDetails The information to summarize the applications.
type RequestSummarizedApplicationsDetails struct {
// Encrypted IDCS Open ID token. This is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required parameter
IdcsOpenId *string `mandatory:"false" json:"idcsOpenId"`
}
func (m RequestSummarizedApplicationsDetails) String() string
func (m RequestSummarizedApplicationsDetails) 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
RequestSummarizedApplicationsRequest wrapper for the RequestSummarizedApplications operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/RequestSummarizedApplications.go.html to see an example of how to use RequestSummarizedApplicationsRequest.
type RequestSummarizedApplicationsRequest struct {
// The parameter holding information to request the summarized applications for a Vb instance
RequestSummarizedApplicationsDetails `contributesTo:"body"`
// Unique Vb Instance identifier.
VbInstanceId *string `mandatory:"true" contributesTo:"path" name:"vbInstanceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated before
// then due to conflicting operations. For example, if a resource has been
// deleted and purged from the system, then a retry of the original creation
// request might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RequestSummarizedApplicationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RequestSummarizedApplicationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RequestSummarizedApplicationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RequestSummarizedApplicationsRequest) String() string
func (request RequestSummarizedApplicationsRequest) 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
RequestSummarizedApplicationsResponse wrapper for the RequestSummarizedApplications operation
type RequestSummarizedApplicationsResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApplicationSummaryCollection instance
ApplicationSummaryCollection `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RequestSummarizedApplicationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RequestSummarizedApplicationsResponse) String() string
StartVbInstanceRequest wrapper for the StartVbInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/StartVbInstance.go.html to see an example of how to use StartVbInstanceRequest.
type StartVbInstanceRequest struct {
// Unique Vb Instance identifier.
VbInstanceId *string `mandatory:"true" contributesTo:"path" name:"vbInstanceId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated before
// then due to conflicting operations. For example, if a resource has been
// deleted and purged from the system, then a retry of the original creation
// request might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StartVbInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartVbInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartVbInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartVbInstanceRequest) String() string
func (request StartVbInstanceRequest) 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
StartVbInstanceResponse wrapper for the StartVbInstance operation
type StartVbInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request.
// You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response StartVbInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartVbInstanceResponse) String() string
StopVbInstanceRequest wrapper for the StopVbInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/StopVbInstance.go.html to see an example of how to use StopVbInstanceRequest.
type StopVbInstanceRequest struct {
// Unique Vb Instance identifier.
VbInstanceId *string `mandatory:"true" contributesTo:"path" name:"vbInstanceId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated before
// then due to conflicting operations. For example, if a resource has been
// deleted and purged from the system, then a retry of the original creation
// request might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StopVbInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopVbInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopVbInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopVbInstanceRequest) String() string
func (request StopVbInstanceRequest) 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
StopVbInstanceResponse wrapper for the StopVbInstance operation
type StopVbInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request.
// You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response StopVbInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopVbInstanceResponse) String() string
UpdateCustomEndpointDetails Details for a custom endpoint for the vb instance (update).
type UpdateCustomEndpointDetails struct {
// A custom hostname to be used for the vb instance URL, in FQDN format.
Hostname *string `mandatory:"true" json:"hostname"`
// Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
// All certificates should be stored in a single base64 encoded secret.
// Note the update will fail if this is not a valid certificate.
CertificateSecretId *string `mandatory:"false" json:"certificateSecretId"`
}
func (m UpdateCustomEndpointDetails) String() string
func (m UpdateCustomEndpointDetails) 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
UpdateVbInstanceDetails Information about updating a VbInstance.
type UpdateVbInstanceDetails struct {
// Vb Instance Identifier.
DisplayName *string `mandatory:"false" json:"displayName"`
// 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"`
// Encrypted IDCS Open ID token. This is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required parameter
IdcsOpenId *string `mandatory:"false" json:"idcsOpenId"`
// The number of Nodes
NodeCount *int `mandatory:"false" json:"nodeCount"`
// Enable Visual Builder. If Visual Builder is enabled alredy, then it cannot be disabled.
IsVisualBuilderEnabled *bool `mandatory:"false" json:"isVisualBuilderEnabled"`
CustomEndpoint *UpdateCustomEndpointDetails `mandatory:"false" json:"customEndpoint"`
// A list of alternate custom endpoints to be used for the vb instance URL
// (contact Oracle for alternateCustomEndpoints availability for a specific instance).
AlternateCustomEndpoints []UpdateCustomEndpointDetails `mandatory:"false" json:"alternateCustomEndpoints"`
}
func (m UpdateVbInstanceDetails) String() string
func (m UpdateVbInstanceDetails) 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
UpdateVbInstanceRequest wrapper for the UpdateVbInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/UpdateVbInstance.go.html to see an example of how to use UpdateVbInstanceRequest.
type UpdateVbInstanceRequest struct {
// Unique Vb Instance identifier.
VbInstanceId *string `mandatory:"true" contributesTo:"path" name:"vbInstanceId"`
// The information to be updated.
UpdateVbInstanceDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateVbInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateVbInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateVbInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateVbInstanceRequest) String() string
func (request UpdateVbInstanceRequest) 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
UpdateVbInstanceResponse wrapper for the UpdateVbInstance operation
type UpdateVbInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request.
// You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateVbInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateVbInstanceResponse) String() string
VbInstance Description of Vb Instance.
type VbInstance struct {
// Unique identifier that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// Vb Instance Identifier, can be renamed.
DisplayName *string `mandatory:"true" json:"displayName"`
// Compartment Identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The current state of the vb instance.
LifecycleState VbInstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The Vb Instance URL.
InstanceUrl *string `mandatory:"true" json:"instanceUrl"`
// The number of Nodes
NodeCount *int `mandatory:"true" json:"nodeCount"`
// The time the the VbInstance was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the VbInstance was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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"`
// 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"`
// Visual Builder is enabled or not.
IsVisualBuilderEnabled *bool `mandatory:"false" json:"isVisualBuilderEnabled"`
CustomEndpoint *CustomEndpointDetails `mandatory:"false" json:"customEndpoint"`
// A list of alternate custom endpoints used for the vb instance URL.
AlternateCustomEndpoints []CustomEndpointDetails `mandatory:"false" json:"alternateCustomEndpoints"`
// The entitlement used for billing purposes.
ConsumptionModel VbInstanceConsumptionModelEnum `mandatory:"false" json:"consumptionModel,omitempty"`
IdcsInfo *IdcsInfoDetails `mandatory:"false" json:"idcsInfo"`
// A list of associated attachments to other services
Attachments []AttachmentDetails `mandatory:"false" json:"attachments"`
// The NAT gateway IP address for the VB service VCN
ServiceNatGatewayIp *string `mandatory:"false" json:"serviceNatGatewayIp"`
// The NAT gateway IP address for the VB management VCN
ManagementNatGatewayIp *string `mandatory:"false" json:"managementNatGatewayIp"`
// The Oracle Cloud ID (OCID) of the Visual Builder service VCN
ServiceVcnId *string `mandatory:"false" json:"serviceVcnId"`
// The Oracle Cloud ID (OCID) of the Visual Builder management VCN
ManagementVcnId *string `mandatory:"false" json:"managementVcnId"`
}
func (m VbInstance) String() string
func (m VbInstance) 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
VbInstanceClient a client for VbInstance
type VbInstanceClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewVbInstanceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client VbInstanceClient, err error)
NewVbInstanceClientWithConfigurationProvider Creates a new default VbInstance client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewVbInstanceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client VbInstanceClient, err error)
NewVbInstanceClientWithOboToken Creates a new default VbInstance client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client VbInstanceClient) ChangeVbInstanceCompartment(ctx context.Context, request ChangeVbInstanceCompartmentRequest) (response ChangeVbInstanceCompartmentResponse, err error)
ChangeVbInstanceCompartment Change the compartment for an vb instance
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/ChangeVbInstanceCompartment.go.html to see an example of how to use ChangeVbInstanceCompartment API.
func (client *VbInstanceClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client VbInstanceClient) CreateVbInstance(ctx context.Context, request CreateVbInstanceRequest) (response CreateVbInstanceResponse, err error)
CreateVbInstance Creates a new Vb Instance.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/CreateVbInstance.go.html to see an example of how to use CreateVbInstance API.
func (client VbInstanceClient) DeleteVbInstance(ctx context.Context, request DeleteVbInstanceRequest) (response DeleteVbInstanceResponse, err error)
DeleteVbInstance Deletes an Vb Instance resource by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/DeleteVbInstance.go.html to see an example of how to use DeleteVbInstance API.
func (client VbInstanceClient) GetVbInstance(ctx context.Context, request GetVbInstanceRequest) (response GetVbInstanceResponse, err error)
GetVbInstance Gets a VbInstance by identifier
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/GetVbInstance.go.html to see an example of how to use GetVbInstance API. A default retry strategy applies to this operation GetVbInstance()
func (client VbInstanceClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client VbInstanceClient) ListVbInstances(ctx context.Context, request ListVbInstancesRequest) (response ListVbInstancesResponse, err error)
ListVbInstances Returns a list of Vb Instances.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/ListVbInstances.go.html to see an example of how to use ListVbInstances API. A default retry strategy applies to this operation ListVbInstances()
func (client VbInstanceClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Get the errors of a work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client VbInstanceClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Get the logs of a work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client VbInstanceClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client VbInstanceClient) RequestSummarizedApplications(ctx context.Context, request RequestSummarizedApplicationsRequest) (response RequestSummarizedApplicationsResponse, err error)
RequestSummarizedApplications Summarizes the applications for a vb instance.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/RequestSummarizedApplications.go.html to see an example of how to use RequestSummarizedApplications API.
func (client *VbInstanceClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client VbInstanceClient) StartVbInstance(ctx context.Context, request StartVbInstanceRequest) (response StartVbInstanceResponse, err error)
StartVbInstance Start an vb instance that was previously in an INACTIVE state. If the previous state is not INACTIVE, then the state of the vbInstance will not be changed and a 409 response returned.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/StartVbInstance.go.html to see an example of how to use StartVbInstance API.
func (client VbInstanceClient) StopVbInstance(ctx context.Context, request StopVbInstanceRequest) (response StopVbInstanceResponse, err error)
StopVbInstance Stop an vb instance that was previously in an ACTIVE state. If the previous state is not ACTIVE, then the state of the vbInstance will not be changed and a 409 response returned.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/StopVbInstance.go.html to see an example of how to use StopVbInstance API.
func (client VbInstanceClient) UpdateVbInstance(ctx context.Context, request UpdateVbInstanceRequest) (response UpdateVbInstanceResponse, err error)
UpdateVbInstance Updates the Vb Instance.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/visualbuilder/UpdateVbInstance.go.html to see an example of how to use UpdateVbInstance API.
VbInstanceConsumptionModelEnum Enum with underlying type: string
type VbInstanceConsumptionModelEnum string
Set of constants representing the allowable values for VbInstanceConsumptionModelEnum
const (
VbInstanceConsumptionModelUcm VbInstanceConsumptionModelEnum = "UCM"
VbInstanceConsumptionModelGov VbInstanceConsumptionModelEnum = "GOV"
VbInstanceConsumptionModelVb4saas VbInstanceConsumptionModelEnum = "VB4SAAS"
)
func GetMappingVbInstanceConsumptionModelEnum(val string) (VbInstanceConsumptionModelEnum, bool)
GetMappingVbInstanceConsumptionModelEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVbInstanceConsumptionModelEnumValues() []VbInstanceConsumptionModelEnum
GetVbInstanceConsumptionModelEnumValues Enumerates the set of values for VbInstanceConsumptionModelEnum
VbInstanceLifecycleStateEnum Enum with underlying type: string
type VbInstanceLifecycleStateEnum string
Set of constants representing the allowable values for VbInstanceLifecycleStateEnum
const (
VbInstanceLifecycleStateCreating VbInstanceLifecycleStateEnum = "CREATING"
VbInstanceLifecycleStateUpdating VbInstanceLifecycleStateEnum = "UPDATING"
VbInstanceLifecycleStateActive VbInstanceLifecycleStateEnum = "ACTIVE"
VbInstanceLifecycleStateInactive VbInstanceLifecycleStateEnum = "INACTIVE"
VbInstanceLifecycleStateDeleting VbInstanceLifecycleStateEnum = "DELETING"
VbInstanceLifecycleStateDeleted VbInstanceLifecycleStateEnum = "DELETED"
VbInstanceLifecycleStateFailed VbInstanceLifecycleStateEnum = "FAILED"
)
func GetMappingVbInstanceLifecycleStateEnum(val string) (VbInstanceLifecycleStateEnum, bool)
GetMappingVbInstanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVbInstanceLifecycleStateEnumValues() []VbInstanceLifecycleStateEnum
GetVbInstanceLifecycleStateEnumValues Enumerates the set of values for VbInstanceLifecycleStateEnum
VbInstanceSummary Summary of the Vb Instance.
type VbInstanceSummary struct {
// Unique identifier that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// Vb Instance Identifier, can be renamed.
DisplayName *string `mandatory:"true" json:"displayName"`
// Compartment Identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The current state of the Vb Instance.
LifecycleState VbInstanceSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The Vb Instance URL.
InstanceUrl *string `mandatory:"true" json:"instanceUrl"`
// The number of Nodes
NodeCount *int `mandatory:"true" json:"nodeCount"`
// The time the the Vb Instance was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the VbInstance was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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"`
// Visual Builder is enabled or not.
IsVisualBuilderEnabled *bool `mandatory:"false" json:"isVisualBuilderEnabled"`
CustomEndpoint *CustomEndpointDetails `mandatory:"false" json:"customEndpoint"`
// A list of alternate custom endpoints used for the vb instance URL.
AlternateCustomEndpoints []CustomEndpointDetails `mandatory:"false" json:"alternateCustomEndpoints"`
// The entitlement used for billing purposes.
ConsumptionModel VbInstanceSummaryConsumptionModelEnum `mandatory:"false" json:"consumptionModel,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"`
// 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 (m VbInstanceSummary) String() string
func (m VbInstanceSummary) 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
VbInstanceSummaryCollection Result of a VbInstance Summary request. Contains VbInstanceSummary items.
type VbInstanceSummaryCollection struct {
// The collection of VbInstanceSummary objects.
Items []VbInstanceSummary `mandatory:"true" json:"items"`
}
func (m VbInstanceSummaryCollection) String() string
func (m VbInstanceSummaryCollection) 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
VbInstanceSummaryConsumptionModelEnum Enum with underlying type: string
type VbInstanceSummaryConsumptionModelEnum string
Set of constants representing the allowable values for VbInstanceSummaryConsumptionModelEnum
const (
VbInstanceSummaryConsumptionModelUcm VbInstanceSummaryConsumptionModelEnum = "UCM"
VbInstanceSummaryConsumptionModelGov VbInstanceSummaryConsumptionModelEnum = "GOV"
VbInstanceSummaryConsumptionModelVb4saas VbInstanceSummaryConsumptionModelEnum = "VB4SAAS"
)
func GetMappingVbInstanceSummaryConsumptionModelEnum(val string) (VbInstanceSummaryConsumptionModelEnum, bool)
GetMappingVbInstanceSummaryConsumptionModelEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVbInstanceSummaryConsumptionModelEnumValues() []VbInstanceSummaryConsumptionModelEnum
GetVbInstanceSummaryConsumptionModelEnumValues Enumerates the set of values for VbInstanceSummaryConsumptionModelEnum
VbInstanceSummaryLifecycleStateEnum Enum with underlying type: string
type VbInstanceSummaryLifecycleStateEnum string
Set of constants representing the allowable values for VbInstanceSummaryLifecycleStateEnum
const (
VbInstanceSummaryLifecycleStateCreating VbInstanceSummaryLifecycleStateEnum = "CREATING"
VbInstanceSummaryLifecycleStateUpdating VbInstanceSummaryLifecycleStateEnum = "UPDATING"
VbInstanceSummaryLifecycleStateActive VbInstanceSummaryLifecycleStateEnum = "ACTIVE"
VbInstanceSummaryLifecycleStateInactive VbInstanceSummaryLifecycleStateEnum = "INACTIVE"
VbInstanceSummaryLifecycleStateDeleting VbInstanceSummaryLifecycleStateEnum = "DELETING"
VbInstanceSummaryLifecycleStateDeleted VbInstanceSummaryLifecycleStateEnum = "DELETED"
VbInstanceSummaryLifecycleStateFailed VbInstanceSummaryLifecycleStateEnum = "FAILED"
)
func GetMappingVbInstanceSummaryLifecycleStateEnum(val string) (VbInstanceSummaryLifecycleStateEnum, bool)
GetMappingVbInstanceSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVbInstanceSummaryLifecycleStateEnumValues() []VbInstanceSummaryLifecycleStateEnum
GetVbInstanceSummaryLifecycleStateEnumValues Enumerates the set of values for VbInstanceSummaryLifecycleStateEnum
WorkRequest A description of work request 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"`
// The date and time the request was started, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError Errors related to a specific work request.
type WorkRequestError struct {
// A short error code that defines the error, meant for programmatic parsing
Code *string `mandatory:"true" json:"code"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
// The date and time the error occurred.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection Result of a WorkRequest Error request. Contains list of WorkRequestError items.
type WorkRequestErrorCollection struct {
// List of objects containing errors related to a specific work request..
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
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
WorkRequestLogEntry Log entries related to a specific work request.
type WorkRequestLogEntry struct {
// The description of an action that occurred.
Message *string `mandatory:"true" json:"message"`
// The date and time the log entry occurred.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection Result of a WorkRequest Log request. Contains list of WorkRequestLog items.
type WorkRequestLogEntryCollection struct {
// List of objects containing logs related to a specific work request..
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
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
WorkRequestOperationTypeEnum Enum with underlying type: string
type WorkRequestOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestOperationTypeEnum
const (
WorkRequestOperationTypeCreateVbInstance WorkRequestOperationTypeEnum = "CREATE_VB_INSTANCE"
WorkRequestOperationTypeUpdateVbInstance WorkRequestOperationTypeEnum = "UPDATE_VB_INSTANCE"
WorkRequestOperationTypeStopVbInstance WorkRequestOperationTypeEnum = "STOP_VB_INSTANCE"
WorkRequestOperationTypeStartVbInstance WorkRequestOperationTypeEnum = "START_VB_INSTANCE"
WorkRequestOperationTypeDeleteVbInstance WorkRequestOperationTypeEnum = "DELETE_VB_INSTANCE"
)
func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)
GetMappingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request is affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the
// work request. A resource being created, updated, or deleted will
// remain in the IN_PROGRESS state until work is complete for that
// resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType WorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResourceActionTypeEnum Enum with underlying type: string
type WorkRequestResourceActionTypeEnum string
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum
const (
WorkRequestResourceActionTypeCreated WorkRequestResourceActionTypeEnum = "CREATED"
WorkRequestResourceActionTypeUpdated WorkRequestResourceActionTypeEnum = "UPDATED"
WorkRequestResourceActionTypeStopped WorkRequestResourceActionTypeEnum = "STOPPED"
WorkRequestResourceActionTypeStarted WorkRequestResourceActionTypeEnum = "STARTED"
WorkRequestResourceActionTypeDeleted WorkRequestResourceActionTypeEnum = "DELETED"
WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
)
func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)
GetMappingWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum
WorkRequestStatusEnum Enum with underlying type: string
type WorkRequestStatusEnum string
Set of constants representing the allowable values for WorkRequestStatusEnum
const (
WorkRequestStatusAccepted WorkRequestStatusEnum = "ACCEPTED"
WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
WorkRequestStatusFailed WorkRequestStatusEnum = "FAILED"
WorkRequestStatusSucceeded WorkRequestStatusEnum = "SUCCEEDED"
WorkRequestStatusCanceling WorkRequestStatusEnum = "CANCELING"
WorkRequestStatusCanceled WorkRequestStatusEnum = "CANCELED"
)
func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)
GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum
WorkRequestSummary A description of work request status.
type WorkRequestSummary struct {
// Type of the work request.
OperationType WorkRequestSummaryOperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status WorkRequestSummaryStatusEnum `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 (m WorkRequestSummary) String() string
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
WorkRequestSummaryCollection Result of a WorkRequest Summary request. Contains WorkRequestSummary items.
type WorkRequestSummaryCollection struct {
// The collection of WorkRequestSummary objects.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
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
WorkRequestSummaryOperationTypeEnum Enum with underlying type: string
type WorkRequestSummaryOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestSummaryOperationTypeEnum
const (
WorkRequestSummaryOperationTypeCreateVbInstance WorkRequestSummaryOperationTypeEnum = "CREATE_VB_INSTANCE"
WorkRequestSummaryOperationTypeUpdateVbInstance WorkRequestSummaryOperationTypeEnum = "UPDATE_VB_INSTANCE"
WorkRequestSummaryOperationTypeStopVbInstance WorkRequestSummaryOperationTypeEnum = "STOP_VB_INSTANCE"
WorkRequestSummaryOperationTypeStartVbInstance WorkRequestSummaryOperationTypeEnum = "START_VB_INSTANCE"
WorkRequestSummaryOperationTypeDeleteVbInstance WorkRequestSummaryOperationTypeEnum = "DELETE_VB_INSTANCE"
)
func GetMappingWorkRequestSummaryOperationTypeEnum(val string) (WorkRequestSummaryOperationTypeEnum, bool)
GetMappingWorkRequestSummaryOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestSummaryOperationTypeEnumValues() []WorkRequestSummaryOperationTypeEnum
GetWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for WorkRequestSummaryOperationTypeEnum
WorkRequestSummaryStatusEnum Enum with underlying type: string
type WorkRequestSummaryStatusEnum string
Set of constants representing the allowable values for WorkRequestSummaryStatusEnum
const (
WorkRequestSummaryStatusAccepted WorkRequestSummaryStatusEnum = "ACCEPTED"
WorkRequestSummaryStatusInProgress WorkRequestSummaryStatusEnum = "IN_PROGRESS"
WorkRequestSummaryStatusFailed WorkRequestSummaryStatusEnum = "FAILED"
WorkRequestSummaryStatusSucceeded WorkRequestSummaryStatusEnum = "SUCCEEDED"
WorkRequestSummaryStatusCanceling WorkRequestSummaryStatusEnum = "CANCELING"
WorkRequestSummaryStatusCanceled WorkRequestSummaryStatusEnum = "CANCELED"
)
func GetMappingWorkRequestSummaryStatusEnum(val string) (WorkRequestSummaryStatusEnum, bool)
GetMappingWorkRequestSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum
GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum