func GetAccessRequestActionTypeEnumStringValues() []string
GetAccessRequestActionTypeEnumStringValues Enumerates the set of values in String for AccessRequestActionTypeEnum
func GetAccessRequestExtLifecycleStateDetailsEnumStringValues() []string
GetAccessRequestExtLifecycleStateDetailsEnumStringValues Enumerates the set of values in String for AccessRequestExtLifecycleStateDetailsEnum
func GetAccessRequestExtLifecycleStateEnumStringValues() []string
GetAccessRequestExtLifecycleStateEnumStringValues Enumerates the set of values in String for AccessRequestExtLifecycleStateEnum
func GetAccessRequestLifecycleStateDetailsEnumStringValues() []string
GetAccessRequestLifecycleStateDetailsEnumStringValues Enumerates the set of values in String for AccessRequestLifecycleStateDetailsEnum
func GetAccessRequestLifecycleStateEnumStringValues() []string
GetAccessRequestLifecycleStateEnumStringValues Enumerates the set of values in String for AccessRequestLifecycleStateEnum
func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetApprovalTemplateLifecycleStateEnumStringValues() []string
GetApprovalTemplateLifecycleStateEnumStringValues Enumerates the set of values in String for ApprovalTemplateLifecycleStateEnum
func GetApproverTypeEnumStringValues() []string
GetApproverTypeEnumStringValues Enumerates the set of values in String for ApproverTypeEnum
func GetExportAccessRequestsLockboxPartnerEnumStringValues() []string
GetExportAccessRequestsLockboxPartnerEnumStringValues Enumerates the set of values in String for ExportAccessRequestsLockboxPartnerEnum
func GetExportAccessRequestsSortByEnumStringValues() []string
GetExportAccessRequestsSortByEnumStringValues Enumerates the set of values in String for ExportAccessRequestsSortByEnum
func GetExportAccessRequestsSortOrderEnumStringValues() []string
GetExportAccessRequestsSortOrderEnumStringValues Enumerates the set of values in String for ExportAccessRequestsSortOrderEnum
func GetListAccessRequestsLockboxPartnerEnumStringValues() []string
GetListAccessRequestsLockboxPartnerEnumStringValues Enumerates the set of values in String for ListAccessRequestsLockboxPartnerEnum
func GetListAccessRequestsSortByEnumStringValues() []string
GetListAccessRequestsSortByEnumStringValues Enumerates the set of values in String for ListAccessRequestsSortByEnum
func GetListAccessRequestsSortOrderEnumStringValues() []string
GetListAccessRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListAccessRequestsSortOrderEnum
func GetListApprovalTemplatesSortByEnumStringValues() []string
GetListApprovalTemplatesSortByEnumStringValues Enumerates the set of values in String for ListApprovalTemplatesSortByEnum
func GetListApprovalTemplatesSortOrderEnumStringValues() []string
GetListApprovalTemplatesSortOrderEnumStringValues Enumerates the set of values in String for ListApprovalTemplatesSortOrderEnum
func GetListLockboxesLockboxPartnerEnumStringValues() []string
GetListLockboxesLockboxPartnerEnumStringValues Enumerates the set of values in String for ListLockboxesLockboxPartnerEnum
func GetListLockboxesSortByEnumStringValues() []string
GetListLockboxesSortByEnumStringValues Enumerates the set of values in String for ListLockboxesSortByEnum
func GetListLockboxesSortOrderEnumStringValues() []string
GetListLockboxesSortOrderEnumStringValues Enumerates the set of values in String for ListLockboxesSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetLockboxAutoApprovalStateEnumStringValues() []string
GetLockboxAutoApprovalStateEnumStringValues Enumerates the set of values in String for LockboxAutoApprovalStateEnum
func GetLockboxLifecycleStateEnumStringValues() []string
GetLockboxLifecycleStateEnumStringValues Enumerates the set of values in String for LockboxLifecycleStateEnum
func GetLockboxPartnerEnumStringValues() []string
GetLockboxPartnerEnumStringValues Enumerates the set of values in String for LockboxPartnerEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetPersonaLevelEnumStringValues() []string
GetPersonaLevelEnumStringValues Enumerates the set of values in String for PersonaLevelEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
AccessContextAttribute Defined by partner while creating a lockbox. These attributes provides context for creating access request
type AccessContextAttribute struct {
// The name of the context attribute
Name *string `mandatory:"true" json:"name"`
// The description of the context attribute
Description *string `mandatory:"false" json:"description"`
// An optional default value used when access request context value is not provided
DefaultValue *string `mandatory:"false" json:"defaultValue"`
// List of context attribute values.
Values []string `mandatory:"false" json:"values"`
}
func (m AccessContextAttribute) String() string
func (m AccessContextAttribute) 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
AccessContextAttributeCollection Contains context attribute entries defined while creating or updating a lockbox.
type AccessContextAttributeCollection struct {
// List of context attributes.
Items []AccessContextAttribute `mandatory:"true" json:"items"`
}
func (m AccessContextAttributeCollection) String() string
func (m AccessContextAttributeCollection) 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
AccessMaterials Access materials details.
type AccessMaterials struct {
// The contents of the material. This is a map that contains the various fields needed for access.
Details map[string]string `mandatory:"true" json:"details"`
}
func (m AccessMaterials) String() string
func (m AccessMaterials) 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
AccessRequest An access request to a customer's resource. An access request is a subsidiary resource of the Lockbox entity.
type AccessRequest struct {
// The unique identifier (OCID) of the access request, which can't be changed after creation.
Id *string `mandatory:"true" json:"id"`
// The unique identifier (OCID) of the lockbox box that the access request is associated with, which can't be changed after creation.
LockboxId *string `mandatory:"true" json:"lockboxId"`
// The name of the access request.
DisplayName *string `mandatory:"true" json:"displayName"`
// The rationale for requesting the access request and any other related details..
Description *string `mandatory:"true" json:"description"`
// The unique identifier of the requestor.
RequestorId *string `mandatory:"true" json:"requestorId"`
// Possible access request lifecycle states.
LifecycleState AccessRequestLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Details of access request lifecycle state.
LifecycleStateDetails AccessRequestLifecycleStateDetailsEnum `mandatory:"true" json:"lifecycleStateDetails"`
// The maximum amount of time operator has access to associated resources.
AccessDuration *string `mandatory:"true" json:"accessDuration"`
// The actions taken by different persona on the access request, e.g. approve/deny/revoke
ActivityLogs []ActivityLog `mandatory:"true" json:"activityLogs"`
// The time the access request was created. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the access request was last updated. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The time the access request expired. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeExpired *common.SDKTime `mandatory:"true" json:"timeExpired"`
// The time the access request was last reminded. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeReminded *common.SDKTime `mandatory:"true" json:"timeReminded"`
// The count of times the access request was reminded.
ReminderCount *int `mandatory:"true" json:"reminderCount"`
// The location of the requestor. Format with be two letters indicatiog operator's country code defined by https://jira-sd.mc1.oracleiaas.com/browse/SSD-17880
// Example: `US`
RequestorLocation *string `mandatory:"true" json:"requestorLocation"`
// The context object containing the access request specific details.
Context map[string]string `mandatory:"false" json:"context"`
// The ticket number raised by external customers
// Example: `3-37509643121`
TicketNumber *string `mandatory:"false" json:"ticketNumber"`
}
func (m AccessRequest) String() string
func (m AccessRequest) 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
AccessRequestActionTypeEnum Enum with underlying type: string
type AccessRequestActionTypeEnum string
Set of constants representing the allowable values for AccessRequestActionTypeEnum
const (
AccessRequestActionTypeApprove AccessRequestActionTypeEnum = "APPROVE"
AccessRequestActionTypeDeny AccessRequestActionTypeEnum = "DENY"
AccessRequestActionTypeRevoke AccessRequestActionTypeEnum = "REVOKE"
AccessRequestActionTypeCancel AccessRequestActionTypeEnum = "CANCEL"
)
func GetAccessRequestActionTypeEnumValues() []AccessRequestActionTypeEnum
GetAccessRequestActionTypeEnumValues Enumerates the set of values for AccessRequestActionTypeEnum
func GetMappingAccessRequestActionTypeEnum(val string) (AccessRequestActionTypeEnum, bool)
GetMappingAccessRequestActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AccessRequestCollection Results of access request search. Contains both AccessRequestSummary items and other information, such as metadata.
type AccessRequestCollection struct {
// List of AccessRequestSummary.
Items []AccessRequestSummary `mandatory:"true" json:"items"`
}
func (m AccessRequestCollection) String() string
func (m AccessRequestCollection) 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
AccessRequestExt An access request to a customer's resource that includes additional requestor metadata. An access request is a subsidiary resource of the Lockbox entity.
type AccessRequestExt struct {
// The unique identifier (OCID) of the access request, which can't be changed after creation.
Id *string `mandatory:"true" json:"id"`
// The unique identifier (OCID) of the lockbox box that the access request is associated with, which can't be changed after creation.
LockboxId *string `mandatory:"true" json:"lockboxId"`
// The name of the access request.
DisplayName *string `mandatory:"true" json:"displayName"`
// The rationale for requesting the access request and any other related details..
Description *string `mandatory:"true" json:"description"`
// The unique identifier of the requestor.
RequestorId *string `mandatory:"true" json:"requestorId"`
// Possible access request lifecycle states.
LifecycleState AccessRequestExtLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Details of access request lifecycle state.
LifecycleStateDetails AccessRequestExtLifecycleStateDetailsEnum `mandatory:"true" json:"lifecycleStateDetails"`
// The maximum amount of time operator has access to associated resources.
AccessDuration *string `mandatory:"true" json:"accessDuration"`
// The actions taken by different persona on the access request, e.g. approve/deny/revoke
ActivityLogs []ActivityLog `mandatory:"true" json:"activityLogs"`
// The time the access request was created. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the access request was last updated. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The time the access request expired. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeExpired *common.SDKTime `mandatory:"true" json:"timeExpired"`
// The time the access request was last reminded. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeReminded *common.SDKTime `mandatory:"true" json:"timeReminded"`
// The count of times the access request was reminded.
ReminderCount *int `mandatory:"true" json:"reminderCount"`
// The location of the requestor. Format with be two letters indicatiog operator's country code defined by https://jira-sd.mc1.oracleiaas.com/browse/SSD-17880
// Example: `US`
RequestorLocation *string `mandatory:"true" json:"requestorLocation"`
// The user name i.e. userId of the requestor.
RequestorUserName *string `mandatory:"true" json:"requestorUserName"`
// The context object containing the access request specific details.
Context map[string]string `mandatory:"false" json:"context"`
// The ticket number raised by external customers
// Example: `3-37509643121`
TicketNumber *string `mandatory:"false" json:"ticketNumber"`
}
func (m AccessRequestExt) String() string
func (m AccessRequestExt) 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
AccessRequestExtLifecycleStateDetailsEnum Enum with underlying type: string
type AccessRequestExtLifecycleStateDetailsEnum string
Set of constants representing the allowable values for AccessRequestExtLifecycleStateDetailsEnum
const (
AccessRequestExtLifecycleStateDetailsProcessing AccessRequestExtLifecycleStateDetailsEnum = "PROCESSING"
AccessRequestExtLifecycleStateDetailsWaitingForApprovals AccessRequestExtLifecycleStateDetailsEnum = "WAITING_FOR_APPROVALS"
AccessRequestExtLifecycleStateDetailsApproved AccessRequestExtLifecycleStateDetailsEnum = "APPROVED"
AccessRequestExtLifecycleStateDetailsAutoApproved AccessRequestExtLifecycleStateDetailsEnum = "AUTO_APPROVED"
AccessRequestExtLifecycleStateDetailsCancellingAccess AccessRequestExtLifecycleStateDetailsEnum = "CANCELLING_ACCESS"
AccessRequestExtLifecycleStateDetailsExpired AccessRequestExtLifecycleStateDetailsEnum = "EXPIRED"
AccessRequestExtLifecycleStateDetailsRevoked AccessRequestExtLifecycleStateDetailsEnum = "REVOKED"
AccessRequestExtLifecycleStateDetailsDenied AccessRequestExtLifecycleStateDetailsEnum = "DENIED"
AccessRequestExtLifecycleStateDetailsError AccessRequestExtLifecycleStateDetailsEnum = "ERROR"
)
func GetAccessRequestExtLifecycleStateDetailsEnumValues() []AccessRequestExtLifecycleStateDetailsEnum
GetAccessRequestExtLifecycleStateDetailsEnumValues Enumerates the set of values for AccessRequestExtLifecycleStateDetailsEnum
func GetMappingAccessRequestExtLifecycleStateDetailsEnum(val string) (AccessRequestExtLifecycleStateDetailsEnum, bool)
GetMappingAccessRequestExtLifecycleStateDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
AccessRequestExtLifecycleStateEnum Enum with underlying type: string
type AccessRequestExtLifecycleStateEnum string
Set of constants representing the allowable values for AccessRequestExtLifecycleStateEnum
const (
AccessRequestExtLifecycleStateInProgress AccessRequestExtLifecycleStateEnum = "IN_PROGRESS"
AccessRequestExtLifecycleStateWaiting AccessRequestExtLifecycleStateEnum = "WAITING"
AccessRequestExtLifecycleStateSucceeded AccessRequestExtLifecycleStateEnum = "SUCCEEDED"
AccessRequestExtLifecycleStateCanceling AccessRequestExtLifecycleStateEnum = "CANCELING"
AccessRequestExtLifecycleStateCanceled AccessRequestExtLifecycleStateEnum = "CANCELED"
AccessRequestExtLifecycleStateFailed AccessRequestExtLifecycleStateEnum = "FAILED"
)
func GetAccessRequestExtLifecycleStateEnumValues() []AccessRequestExtLifecycleStateEnum
GetAccessRequestExtLifecycleStateEnumValues Enumerates the set of values for AccessRequestExtLifecycleStateEnum
func GetMappingAccessRequestExtLifecycleStateEnum(val string) (AccessRequestExtLifecycleStateEnum, bool)
GetMappingAccessRequestExtLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AccessRequestLifecycleStateDetailsEnum Enum with underlying type: string
type AccessRequestLifecycleStateDetailsEnum string
Set of constants representing the allowable values for AccessRequestLifecycleStateDetailsEnum
const (
AccessRequestLifecycleStateDetailsProcessing AccessRequestLifecycleStateDetailsEnum = "PROCESSING"
AccessRequestLifecycleStateDetailsWaitingForApprovals AccessRequestLifecycleStateDetailsEnum = "WAITING_FOR_APPROVALS"
AccessRequestLifecycleStateDetailsApproved AccessRequestLifecycleStateDetailsEnum = "APPROVED"
AccessRequestLifecycleStateDetailsAutoApproved AccessRequestLifecycleStateDetailsEnum = "AUTO_APPROVED"
AccessRequestLifecycleStateDetailsCancellingAccess AccessRequestLifecycleStateDetailsEnum = "CANCELLING_ACCESS"
AccessRequestLifecycleStateDetailsExpired AccessRequestLifecycleStateDetailsEnum = "EXPIRED"
AccessRequestLifecycleStateDetailsRevoked AccessRequestLifecycleStateDetailsEnum = "REVOKED"
AccessRequestLifecycleStateDetailsDenied AccessRequestLifecycleStateDetailsEnum = "DENIED"
AccessRequestLifecycleStateDetailsError AccessRequestLifecycleStateDetailsEnum = "ERROR"
)
func GetAccessRequestLifecycleStateDetailsEnumValues() []AccessRequestLifecycleStateDetailsEnum
GetAccessRequestLifecycleStateDetailsEnumValues Enumerates the set of values for AccessRequestLifecycleStateDetailsEnum
func GetMappingAccessRequestLifecycleStateDetailsEnum(val string) (AccessRequestLifecycleStateDetailsEnum, bool)
GetMappingAccessRequestLifecycleStateDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
AccessRequestLifecycleStateEnum Enum with underlying type: string
type AccessRequestLifecycleStateEnum string
Set of constants representing the allowable values for AccessRequestLifecycleStateEnum
const (
AccessRequestLifecycleStateInProgress AccessRequestLifecycleStateEnum = "IN_PROGRESS"
AccessRequestLifecycleStateWaiting AccessRequestLifecycleStateEnum = "WAITING"
AccessRequestLifecycleStateSucceeded AccessRequestLifecycleStateEnum = "SUCCEEDED"
AccessRequestLifecycleStateCanceling AccessRequestLifecycleStateEnum = "CANCELING"
AccessRequestLifecycleStateCanceled AccessRequestLifecycleStateEnum = "CANCELED"
AccessRequestLifecycleStateFailed AccessRequestLifecycleStateEnum = "FAILED"
)
func GetAccessRequestLifecycleStateEnumValues() []AccessRequestLifecycleStateEnum
GetAccessRequestLifecycleStateEnumValues Enumerates the set of values for AccessRequestLifecycleStateEnum
func GetMappingAccessRequestLifecycleStateEnum(val string) (AccessRequestLifecycleStateEnum, bool)
GetMappingAccessRequestLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AccessRequestSummary Summary information for an access request.
type AccessRequestSummary struct {
// The unique identifier (OCID) of the access request, which can't be changed after creation.
Id *string `mandatory:"true" json:"id"`
// The unique identifier (OCID) of the lockbox box that the access request is associated with, which can't be changed after creation.
LockboxId *string `mandatory:"true" json:"lockboxId"`
// The name of the access request.
DisplayName *string `mandatory:"true" json:"displayName"`
// The rationale for requesting the access request.
Description *string `mandatory:"true" json:"description"`
// The unique identifier of the requestor.
RequestorId *string `mandatory:"true" json:"requestorId"`
// The current state of the access request.
LifecycleState AccessRequestLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the access request was created. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the access request was last updated. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The time the access request expired. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeExpired *common.SDKTime `mandatory:"true" json:"timeExpired"`
// The two-char country code of the requestor while creating the access request
// Example: `US`
RequestorLocation *string `mandatory:"false" json:"requestorLocation"`
// The maximum amount of time operator has access to associated resources.
AccessDuration *string `mandatory:"false" json:"accessDuration"`
// The ticket number raised by external customers
// Example: `3-37509643121`
TicketNumber *string `mandatory:"false" json:"ticketNumber"`
// 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 AccessRequestSummary) String() string
func (m AccessRequestSummary) 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
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"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ActivityLog The log of the action taken by different persona on the access request, e.g. approve/deny/revoke
type ActivityLog struct {
// User OCID of the persona
UserId *string `mandatory:"false" json:"userId"`
// Level of the persona
UserLevel PersonaLevelEnum `mandatory:"false" json:"userLevel,omitempty"`
// The action take by persona
Action AccessRequestActionTypeEnum `mandatory:"false" json:"action,omitempty"`
// The action justification or details.
Message *string `mandatory:"false" json:"message"`
// The time the action was taken. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m ActivityLog) String() string
func (m ActivityLog) 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
ApprovalTemplate Group/User OCIDs of those who can approve/deny/revoke operator's request to access associated resources.
type ApprovalTemplate struct {
// The unique identifier (OCID) of the approval template, which can't be changed after creation.
Id *string `mandatory:"true" json:"id"`
// The approval template display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The unique identifier (OCID) of the customer compartment where the approval template is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the the approval template was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the approval template.
LifecycleState ApprovalTemplateLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
ApproverLevels *ApproverLevels `mandatory:"false" json:"approverLevels"`
// The auto approval state of the lockbox.
AutoApprovalState LockboxAutoApprovalStateEnum `mandatory:"false" json:"autoApprovalState,omitempty"`
// The time the approval template was updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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 ApprovalTemplate) String() string
func (m ApprovalTemplate) 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
ApprovalTemplateCollection Results of approval template search. Contains both ApprovalTemplateSummary items and other information, such as metadata.
type ApprovalTemplateCollection struct {
// List of ApprovalTemplateSummary.
Items []ApprovalTemplateSummary `mandatory:"true" json:"items"`
}
func (m ApprovalTemplateCollection) String() string
func (m ApprovalTemplateCollection) 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
ApprovalTemplateLifecycleStateEnum Enum with underlying type: string
type ApprovalTemplateLifecycleStateEnum string
Set of constants representing the allowable values for ApprovalTemplateLifecycleStateEnum
const (
ApprovalTemplateLifecycleStateActive ApprovalTemplateLifecycleStateEnum = "ACTIVE"
ApprovalTemplateLifecycleStateCreating ApprovalTemplateLifecycleStateEnum = "CREATING"
ApprovalTemplateLifecycleStateUpdating ApprovalTemplateLifecycleStateEnum = "UPDATING"
ApprovalTemplateLifecycleStateDeleting ApprovalTemplateLifecycleStateEnum = "DELETING"
ApprovalTemplateLifecycleStateDeleted ApprovalTemplateLifecycleStateEnum = "DELETED"
ApprovalTemplateLifecycleStateFailed ApprovalTemplateLifecycleStateEnum = "FAILED"
)
func GetApprovalTemplateLifecycleStateEnumValues() []ApprovalTemplateLifecycleStateEnum
GetApprovalTemplateLifecycleStateEnumValues Enumerates the set of values for ApprovalTemplateLifecycleStateEnum
func GetMappingApprovalTemplateLifecycleStateEnum(val string) (ApprovalTemplateLifecycleStateEnum, bool)
GetMappingApprovalTemplateLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ApprovalTemplateSummary Summary info for an approval tmeplate.
type ApprovalTemplateSummary struct {
// The unique identifier (OCID) of the approval template, which can't be changed after creation.
Id *string `mandatory:"true" json:"id"`
// The approval template display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The unique identifier (OCID) of the customer compartment where the approval template is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the the approval template was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the approval template.
LifecycleState ApprovalTemplateLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
ApproverLevels *ApproverLevels `mandatory:"false" json:"approverLevels"`
// The auto approval state of the lockbox.
AutoApprovalState LockboxAutoApprovalStateEnum `mandatory:"false" json:"autoApprovalState,omitempty"`
// The time the approval template was updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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 ApprovalTemplateSummary) String() string
func (m ApprovalTemplateSummary) 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
ApproverInfo The approver data for this approver level.
type ApproverInfo struct {
// The approver type of this approver level.
ApproverType ApproverTypeEnum `mandatory:"true" json:"approverType"`
// The group or user ocid of the approver for this approver level.
ApproverId *string `mandatory:"true" json:"approverId"`
// The identity domain ocid of the approver.
DomainId *string `mandatory:"false" json:"domainId"`
}
func (m ApproverInfo) String() string
func (m ApproverInfo) 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
ApproverLevels The approver levels.
type ApproverLevels struct {
Level1 *ApproverInfo `mandatory:"true" json:"level1"`
Level2 *ApproverInfo `mandatory:"false" json:"level2"`
Level3 *ApproverInfo `mandatory:"false" json:"level3"`
}
func (m ApproverLevels) String() string
func (m ApproverLevels) 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
ApproverTypeEnum Enum with underlying type: string
type ApproverTypeEnum string
Set of constants representing the allowable values for ApproverTypeEnum
const (
ApproverTypeGroup ApproverTypeEnum = "GROUP"
ApproverTypeUser ApproverTypeEnum = "USER"
)
func GetApproverTypeEnumValues() []ApproverTypeEnum
GetApproverTypeEnumValues Enumerates the set of values for ApproverTypeEnum
func GetMappingApproverTypeEnum(val string) (ApproverTypeEnum, bool)
GetMappingApproverTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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 CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) 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
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
ChangeApprovalTemplateCompartmentDetails The information to be updated.
type ChangeApprovalTemplateCompartmentDetails struct {
// The unique identifier (OCID) of the compartment where the resource is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeApprovalTemplateCompartmentDetails) String() string
func (m ChangeApprovalTemplateCompartmentDetails) 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
ChangeApprovalTemplateCompartmentRequest wrapper for the ChangeApprovalTemplateCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ChangeApprovalTemplateCompartment.go.html to see an example of how to use ChangeApprovalTemplateCompartmentRequest.
type ChangeApprovalTemplateCompartmentRequest struct {
// The unique identifier (OCID) of the approval template.
ApprovalTemplateId *string `mandatory:"true" contributesTo:"path" name:"approvalTemplateId"`
// The information to be updated.
ChangeApprovalTemplateCompartmentDetails `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 ChangeApprovalTemplateCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeApprovalTemplateCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeApprovalTemplateCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeApprovalTemplateCompartmentRequest) String() string
func (request ChangeApprovalTemplateCompartmentRequest) 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
ChangeApprovalTemplateCompartmentResponse wrapper for the ChangeApprovalTemplateCompartment operation
type ChangeApprovalTemplateCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 ChangeApprovalTemplateCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeApprovalTemplateCompartmentResponse) String() string
ChangeLockboxCompartmentDetails The information to be updated.
type ChangeLockboxCompartmentDetails struct {
// The unique identifier (OCID) of the compartment where the resource is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeLockboxCompartmentDetails) String() string
func (m ChangeLockboxCompartmentDetails) 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
ChangeLockboxCompartmentRequest wrapper for the ChangeLockboxCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ChangeLockboxCompartment.go.html to see an example of how to use ChangeLockboxCompartmentRequest.
type ChangeLockboxCompartmentRequest struct {
// unique Lockbox identifier
LockboxId *string `mandatory:"true" contributesTo:"path" name:"lockboxId"`
// The information to be updated.
ChangeLockboxCompartmentDetails `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 ChangeLockboxCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeLockboxCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeLockboxCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeLockboxCompartmentRequest) String() string
func (request ChangeLockboxCompartmentRequest) 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
ChangeLockboxCompartmentResponse wrapper for the ChangeLockboxCompartment operation
type ChangeLockboxCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 ChangeLockboxCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeLockboxCompartmentResponse) String() string
CreateAccessRequestDetails The configuration details for a new access request. We don't accept a compartmentId parameter because it is implied to be the same as the lockbox as a subsidiary resource. The requestorId is also based on the caller user info.
type CreateAccessRequestDetails struct {
// The unique identifier (OCID) of the lockbox box that the access request is associated with which is immutable.
LockboxId *string `mandatory:"true" json:"lockboxId"`
// The rationale for requesting the access request.
Description *string `mandatory:"true" json:"description"`
// The maximum amount of time operator has access to associated resources.
AccessDuration *string `mandatory:"true" json:"accessDuration"`
// The name of the access request.
DisplayName *string `mandatory:"false" json:"displayName"`
// The context object containing the access request specific details.
Context map[string]string `mandatory:"false" json:"context"`
// The ticket number raised by external customers
// Example: `3-37509643121`
TicketNumber *string `mandatory:"false" json:"ticketNumber"`
}
func (m CreateAccessRequestDetails) String() string
func (m CreateAccessRequestDetails) 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
CreateAccessRequestRequest wrapper for the CreateAccessRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/CreateAccessRequest.go.html to see an example of how to use CreateAccessRequestRequest.
type CreateAccessRequestRequest struct {
// Details for the new access request.
CreateAccessRequestDetails `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 CreateAccessRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAccessRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAccessRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAccessRequestRequest) String() string
func (request CreateAccessRequestRequest) 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
CreateAccessRequestResponse wrapper for the CreateAccessRequest operation
type CreateAccessRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The AccessRequest instance
AccessRequest `presentIn:"body"`
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
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"`
// this contains the full URI for the get request, e.g. "https://iaas.us-phoenix-1.oraclecloud.com/20210331/lockbox/<some-ocid>"
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateAccessRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAccessRequestResponse) String() string
CreateApprovalTemplateDetails The configuration details for a new approval template.
type CreateApprovalTemplateDetails struct {
// The unique identifier (OCID) of the compartment where the resource is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// approval template identifier
DisplayName *string `mandatory:"false" json:"displayName"`
ApproverLevels *ApproverLevels `mandatory:"false" json:"approverLevels"`
// The auto approval state of the lockbox.
AutoApprovalState LockboxAutoApprovalStateEnum `mandatory:"false" json:"autoApprovalState,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"`
}
func (m CreateApprovalTemplateDetails) String() string
func (m CreateApprovalTemplateDetails) 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
CreateApprovalTemplateRequest wrapper for the CreateApprovalTemplate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/CreateApprovalTemplate.go.html to see an example of how to use CreateApprovalTemplateRequest.
type CreateApprovalTemplateRequest struct {
// Details for the new approval template.
CreateApprovalTemplateDetails `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 CreateApprovalTemplateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateApprovalTemplateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateApprovalTemplateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateApprovalTemplateRequest) String() string
func (request CreateApprovalTemplateRequest) 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
CreateApprovalTemplateResponse wrapper for the CreateApprovalTemplate operation
type CreateApprovalTemplateResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApprovalTemplate instance
ApprovalTemplate `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"`
// this contains the full URI for the get request, e.g. "https://iaas.us-phoenix-1.oraclecloud.com/20210331/lockbox/<some-ocid>"
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateApprovalTemplateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateApprovalTemplateResponse) String() string
CreateLockboxDetails The information about new Lockbox.
type CreateLockboxDetails struct {
// The unique identifier (OCID) of the customer's resource.
ResourceId *string `mandatory:"true" json:"resourceId"`
// The unique identifier (OCID) of the compartment where the resource is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
AccessContextAttributes *AccessContextAttributeCollection `mandatory:"true" json:"accessContextAttributes"`
// Lockbox Identifier
DisplayName *string `mandatory:"false" json:"displayName"`
// The partner using this lockbox to lock a resource.
LockboxPartner LockboxPartnerEnum `mandatory:"false" json:"lockboxPartner,omitempty"`
// The unique identifier (OCID) of partner resource using this lockbox to lock a resource
PartnerId *string `mandatory:"false" json:"partnerId"`
// Compartment Identifier
PartnerCompartmentId *string `mandatory:"false" json:"partnerCompartmentId"`
// Approval template ID
ApprovalTemplateId *string `mandatory:"false" json:"approvalTemplateId"`
// The maximum amount of time operator has access to associated resources.
MaxAccessDuration *string `mandatory:"false" json:"maxAccessDuration"`
// 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 (m CreateLockboxDetails) String() string
func (m CreateLockboxDetails) 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
CreateLockboxRequest wrapper for the CreateLockbox operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/CreateLockbox.go.html to see an example of how to use CreateLockboxRequest.
type CreateLockboxRequest struct {
// Details for the new Lockbox.
CreateLockboxDetails `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 CreateLockboxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateLockboxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateLockboxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateLockboxRequest) String() string
func (request CreateLockboxRequest) 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
CreateLockboxResponse wrapper for the CreateLockbox operation
type CreateLockboxResponse struct {
// The underlying http response
RawResponse *http.Response
// The Lockbox instance
Lockbox `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"`
// this contains the full URI for the get request, e.g. "https://iaas.us-phoenix-1.oraclecloud.com/20210331/lockbox/<some-ocid>"
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateLockboxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateLockboxResponse) String() string
DeleteApprovalTemplateRequest wrapper for the DeleteApprovalTemplate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/DeleteApprovalTemplate.go.html to see an example of how to use DeleteApprovalTemplateRequest.
type DeleteApprovalTemplateRequest struct {
// The unique identifier (OCID) of the approval template.
ApprovalTemplateId *string `mandatory:"true" contributesTo:"path" name:"approvalTemplateId"`
// 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 DeleteApprovalTemplateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteApprovalTemplateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteApprovalTemplateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteApprovalTemplateRequest) String() string
func (request DeleteApprovalTemplateRequest) 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
DeleteApprovalTemplateResponse wrapper for the DeleteApprovalTemplate operation
type DeleteApprovalTemplateResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 DeleteApprovalTemplateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteApprovalTemplateResponse) String() string
DeleteLockboxRequest wrapper for the DeleteLockbox operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/DeleteLockbox.go.html to see an example of how to use DeleteLockboxRequest.
type DeleteLockboxRequest struct {
// unique Lockbox identifier
LockboxId *string `mandatory:"true" contributesTo:"path" name:"lockboxId"`
// 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 DeleteLockboxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteLockboxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteLockboxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteLockboxRequest) String() string
func (request DeleteLockboxRequest) 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
DeleteLockboxResponse wrapper for the DeleteLockbox operation
type DeleteLockboxResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 DeleteLockboxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteLockboxResponse) String() string
ExportAccessRequestsDetails Details for generating report of Access Requests to export action
type ExportAccessRequestsDetails struct {
// The unique identifier (OCID) of the lockbox box that the access request is associated with which is immutable.
LockboxId *string `mandatory:"true" json:"lockboxId"`
// Date and time after which access requests were created, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339)
TimeCreatedAfter *common.SDKTime `mandatory:"true" json:"timeCreatedAfter"`
// Date and time before which access requests were created, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339)s
TimeCreatedBefore *common.SDKTime `mandatory:"true" json:"timeCreatedBefore"`
}
func (m ExportAccessRequestsDetails) String() string
func (m ExportAccessRequestsDetails) 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
ExportAccessRequestsLockboxPartnerEnum Enum with underlying type: string
type ExportAccessRequestsLockboxPartnerEnum string
Set of constants representing the allowable values for ExportAccessRequestsLockboxPartnerEnum
const (
ExportAccessRequestsLockboxPartnerFaaas ExportAccessRequestsLockboxPartnerEnum = "FAAAS"
ExportAccessRequestsLockboxPartnerCanary ExportAccessRequestsLockboxPartnerEnum = "CANARY"
)
func GetExportAccessRequestsLockboxPartnerEnumValues() []ExportAccessRequestsLockboxPartnerEnum
GetExportAccessRequestsLockboxPartnerEnumValues Enumerates the set of values for ExportAccessRequestsLockboxPartnerEnum
func GetMappingExportAccessRequestsLockboxPartnerEnum(val string) (ExportAccessRequestsLockboxPartnerEnum, bool)
GetMappingExportAccessRequestsLockboxPartnerEnum performs case Insensitive comparison on enum value and return the desired enum
ExportAccessRequestsRequest wrapper for the ExportAccessRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ExportAccessRequests.go.html to see an example of how to use ExportAccessRequestsRequest.
type ExportAccessRequestsRequest struct {
// Exports the list of access requests for given date range in text format
ExportAccessRequestsDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A generic Id query param used to filter lockbox, access request and approval template by Id.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState AccessRequestLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The name of the lockbox partner.
LockboxPartner ExportAccessRequestsLockboxPartnerEnum `mandatory:"false" contributesTo:"query" name:"lockboxPartner" omitEmpty:"true"`
// The ID of the partner.
PartnerId *string `mandatory:"false" contributesTo:"query" name:"partnerId"`
// The unique identifier (OCID) of the requestor in which to list resources.
RequestorId *string `mandatory:"false" contributesTo:"query" name:"requestorId"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ExportAccessRequestsSortOrderEnum `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.
SortBy ExportAccessRequestsSortByEnum `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 (request ExportAccessRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ExportAccessRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ExportAccessRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ExportAccessRequestsRequest) String() string
func (request ExportAccessRequestsRequest) 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
ExportAccessRequestsResponse wrapper for the ExportAccessRequests operation
type ExportAccessRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of io.ReadCloser instances
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// 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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response ExportAccessRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ExportAccessRequestsResponse) String() string
ExportAccessRequestsSortByEnum Enum with underlying type: string
type ExportAccessRequestsSortByEnum string
Set of constants representing the allowable values for ExportAccessRequestsSortByEnum
const (
ExportAccessRequestsSortByTimecreated ExportAccessRequestsSortByEnum = "timeCreated"
ExportAccessRequestsSortByDisplayname ExportAccessRequestsSortByEnum = "displayName"
ExportAccessRequestsSortById ExportAccessRequestsSortByEnum = "id"
)
func GetExportAccessRequestsSortByEnumValues() []ExportAccessRequestsSortByEnum
GetExportAccessRequestsSortByEnumValues Enumerates the set of values for ExportAccessRequestsSortByEnum
func GetMappingExportAccessRequestsSortByEnum(val string) (ExportAccessRequestsSortByEnum, bool)
GetMappingExportAccessRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ExportAccessRequestsSortOrderEnum Enum with underlying type: string
type ExportAccessRequestsSortOrderEnum string
Set of constants representing the allowable values for ExportAccessRequestsSortOrderEnum
const (
ExportAccessRequestsSortOrderAsc ExportAccessRequestsSortOrderEnum = "ASC"
ExportAccessRequestsSortOrderDesc ExportAccessRequestsSortOrderEnum = "DESC"
)
func GetExportAccessRequestsSortOrderEnumValues() []ExportAccessRequestsSortOrderEnum
GetExportAccessRequestsSortOrderEnumValues Enumerates the set of values for ExportAccessRequestsSortOrderEnum
func GetMappingExportAccessRequestsSortOrderEnum(val string) (ExportAccessRequestsSortOrderEnum, bool)
GetMappingExportAccessRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
GetAccessMaterialsRequest wrapper for the GetAccessMaterials operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/GetAccessMaterials.go.html to see an example of how to use GetAccessMaterialsRequest.
type GetAccessMaterialsRequest struct {
// The unique identifier (OCID) of the access request.
AccessRequestId *string `mandatory:"true" contributesTo:"path" name:"accessRequestId"`
// 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 GetAccessMaterialsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAccessMaterialsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAccessMaterialsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAccessMaterialsRequest) String() string
func (request GetAccessMaterialsRequest) 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
GetAccessMaterialsResponse wrapper for the GetAccessMaterials operation
type GetAccessMaterialsResponse struct {
// The underlying http response
RawResponse *http.Response
// The AccessMaterials instance
AccessMaterials `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"`
}
func (response GetAccessMaterialsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAccessMaterialsResponse) String() string
GetAccessRequestInternalRequest wrapper for the GetAccessRequestInternal operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/GetAccessRequestInternal.go.html to see an example of how to use GetAccessRequestInternalRequest.
type GetAccessRequestInternalRequest struct {
// The unique identifier (OCID) of the access request.
AccessRequestId *string `mandatory:"true" contributesTo:"path" name:"accessRequestId"`
// 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 GetAccessRequestInternalRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAccessRequestInternalRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAccessRequestInternalRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAccessRequestInternalRequest) String() string
func (request GetAccessRequestInternalRequest) 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
GetAccessRequestInternalResponse wrapper for the GetAccessRequestInternal operation
type GetAccessRequestInternalResponse struct {
// The underlying http response
RawResponse *http.Response
// The AccessRequestExt instance
AccessRequestExt `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 GetAccessRequestInternalResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAccessRequestInternalResponse) String() string
GetAccessRequestRequest wrapper for the GetAccessRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/GetAccessRequest.go.html to see an example of how to use GetAccessRequestRequest.
type GetAccessRequestRequest struct {
// The unique identifier (OCID) of the access request.
AccessRequestId *string `mandatory:"true" contributesTo:"path" name:"accessRequestId"`
// 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 GetAccessRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAccessRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAccessRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAccessRequestRequest) String() string
func (request GetAccessRequestRequest) 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
GetAccessRequestResponse wrapper for the GetAccessRequest operation
type GetAccessRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The AccessRequest instance
AccessRequest `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 GetAccessRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAccessRequestResponse) String() string
GetApprovalTemplateRequest wrapper for the GetApprovalTemplate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/GetApprovalTemplate.go.html to see an example of how to use GetApprovalTemplateRequest.
type GetApprovalTemplateRequest struct {
// The unique identifier (OCID) of the approval template.
ApprovalTemplateId *string `mandatory:"true" contributesTo:"path" name:"approvalTemplateId"`
// 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 GetApprovalTemplateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetApprovalTemplateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetApprovalTemplateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetApprovalTemplateRequest) String() string
func (request GetApprovalTemplateRequest) 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
GetApprovalTemplateResponse wrapper for the GetApprovalTemplate operation
type GetApprovalTemplateResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApprovalTemplate instance
ApprovalTemplate `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 GetApprovalTemplateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetApprovalTemplateResponse) String() string
GetLockboxRequest wrapper for the GetLockbox operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/GetLockbox.go.html to see an example of how to use GetLockboxRequest.
type GetLockboxRequest struct {
// unique Lockbox identifier
LockboxId *string `mandatory:"true" contributesTo:"path" name:"lockboxId"`
// 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 GetLockboxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetLockboxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetLockboxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetLockboxRequest) String() string
func (request GetLockboxRequest) 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
GetLockboxResponse wrapper for the GetLockbox operation
type GetLockboxResponse struct {
// The underlying http response
RawResponse *http.Response
// The Lockbox instance
Lockbox `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 GetLockboxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetLockboxResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HandleAccessRequestDetails The details for handling access request.
type HandleAccessRequestDetails struct {
// The action take by persona
Action AccessRequestActionTypeEnum `mandatory:"true" json:"action"`
// Action justification or details.
Message *string `mandatory:"false" json:"message"`
}
func (m HandleAccessRequestDetails) String() string
func (m HandleAccessRequestDetails) 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
HandleAccessRequestRequest wrapper for the HandleAccessRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/HandleAccessRequest.go.html to see an example of how to use HandleAccessRequestRequest.
type HandleAccessRequestRequest struct {
// The unique identifier (OCID) of the access request.
AccessRequestId *string `mandatory:"true" contributesTo:"path" name:"accessRequestId"`
// The details of handling access request
HandleAccessRequestDetails `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"`
// 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 HandleAccessRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request HandleAccessRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request HandleAccessRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request HandleAccessRequestRequest) String() string
func (request HandleAccessRequestRequest) 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
HandleAccessRequestResponse wrapper for the HandleAccessRequest operation
type HandleAccessRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
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 HandleAccessRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response HandleAccessRequestResponse) String() string
ListAccessRequestsLockboxPartnerEnum Enum with underlying type: string
type ListAccessRequestsLockboxPartnerEnum string
Set of constants representing the allowable values for ListAccessRequestsLockboxPartnerEnum
const (
ListAccessRequestsLockboxPartnerFaaas ListAccessRequestsLockboxPartnerEnum = "FAAAS"
ListAccessRequestsLockboxPartnerCanary ListAccessRequestsLockboxPartnerEnum = "CANARY"
)
func GetListAccessRequestsLockboxPartnerEnumValues() []ListAccessRequestsLockboxPartnerEnum
GetListAccessRequestsLockboxPartnerEnumValues Enumerates the set of values for ListAccessRequestsLockboxPartnerEnum
func GetMappingListAccessRequestsLockboxPartnerEnum(val string) (ListAccessRequestsLockboxPartnerEnum, bool)
GetMappingListAccessRequestsLockboxPartnerEnum performs case Insensitive comparison on enum value and return the desired enum
ListAccessRequestsRequest wrapper for the ListAccessRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ListAccessRequests.go.html to see an example of how to use ListAccessRequestsRequest.
type ListAccessRequestsRequest struct {
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The unique identifier (OCID) of the associated lockbox.
LockboxId *string `mandatory:"false" contributesTo:"query" name:"lockboxId"`
// A generic Id query param used to filter lockbox, access request and approval template by Id.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState AccessRequestLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The name of the lockbox partner.
LockboxPartner ListAccessRequestsLockboxPartnerEnum `mandatory:"false" contributesTo:"query" name:"lockboxPartner" omitEmpty:"true"`
// The ID of the partner.
PartnerId *string `mandatory:"false" contributesTo:"query" name:"partnerId"`
// The unique identifier (OCID) of the requestor in which to list resources.
RequestorId *string `mandatory:"false" contributesTo:"query" name:"requestorId"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListAccessRequestsSortOrderEnum `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.
SortBy ListAccessRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Date and time on or after which Access Requests were created, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339)
TimeCreatedAfter *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedAfter"`
// Date and time on or before which Access requests were created, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339)
TimeCreatedBefore *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedBefore"`
// 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 ListAccessRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAccessRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAccessRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAccessRequestsRequest) String() string
func (request ListAccessRequestsRequest) 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
ListAccessRequestsResponse wrapper for the ListAccessRequests operation
type ListAccessRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AccessRequestCollection instances
AccessRequestCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListAccessRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAccessRequestsResponse) String() string
ListAccessRequestsSortByEnum Enum with underlying type: string
type ListAccessRequestsSortByEnum string
Set of constants representing the allowable values for ListAccessRequestsSortByEnum
const (
ListAccessRequestsSortByTimecreated ListAccessRequestsSortByEnum = "timeCreated"
ListAccessRequestsSortByDisplayname ListAccessRequestsSortByEnum = "displayName"
ListAccessRequestsSortById ListAccessRequestsSortByEnum = "id"
)
func GetListAccessRequestsSortByEnumValues() []ListAccessRequestsSortByEnum
GetListAccessRequestsSortByEnumValues Enumerates the set of values for ListAccessRequestsSortByEnum
func GetMappingListAccessRequestsSortByEnum(val string) (ListAccessRequestsSortByEnum, bool)
GetMappingListAccessRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAccessRequestsSortOrderEnum Enum with underlying type: string
type ListAccessRequestsSortOrderEnum string
Set of constants representing the allowable values for ListAccessRequestsSortOrderEnum
const (
ListAccessRequestsSortOrderAsc ListAccessRequestsSortOrderEnum = "ASC"
ListAccessRequestsSortOrderDesc ListAccessRequestsSortOrderEnum = "DESC"
)
func GetListAccessRequestsSortOrderEnumValues() []ListAccessRequestsSortOrderEnum
GetListAccessRequestsSortOrderEnumValues Enumerates the set of values for ListAccessRequestsSortOrderEnum
func GetMappingListAccessRequestsSortOrderEnum(val string) (ListAccessRequestsSortOrderEnum, bool)
GetMappingListAccessRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListApprovalTemplatesRequest wrapper for the ListApprovalTemplates operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ListApprovalTemplates.go.html to see an example of how to use ListApprovalTemplatesRequest.
type ListApprovalTemplatesRequest struct {
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A generic Id query param used to filter lockbox, access request and approval template by Id.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources for which their lifecycleState matches the given lifecycleState.
LifecycleState ApprovalTemplateLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListApprovalTemplatesSortOrderEnum `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.
SortBy ListApprovalTemplatesSortByEnum `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 (request ListApprovalTemplatesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListApprovalTemplatesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListApprovalTemplatesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListApprovalTemplatesRequest) String() string
func (request ListApprovalTemplatesRequest) 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
ListApprovalTemplatesResponse wrapper for the ListApprovalTemplates operation
type ListApprovalTemplatesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ApprovalTemplateCollection instances
ApprovalTemplateCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListApprovalTemplatesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListApprovalTemplatesResponse) String() string
ListApprovalTemplatesSortByEnum Enum with underlying type: string
type ListApprovalTemplatesSortByEnum string
Set of constants representing the allowable values for ListApprovalTemplatesSortByEnum
const (
ListApprovalTemplatesSortByTimecreated ListApprovalTemplatesSortByEnum = "timeCreated"
ListApprovalTemplatesSortByDisplayname ListApprovalTemplatesSortByEnum = "displayName"
ListApprovalTemplatesSortById ListApprovalTemplatesSortByEnum = "id"
)
func GetListApprovalTemplatesSortByEnumValues() []ListApprovalTemplatesSortByEnum
GetListApprovalTemplatesSortByEnumValues Enumerates the set of values for ListApprovalTemplatesSortByEnum
func GetMappingListApprovalTemplatesSortByEnum(val string) (ListApprovalTemplatesSortByEnum, bool)
GetMappingListApprovalTemplatesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListApprovalTemplatesSortOrderEnum Enum with underlying type: string
type ListApprovalTemplatesSortOrderEnum string
Set of constants representing the allowable values for ListApprovalTemplatesSortOrderEnum
const (
ListApprovalTemplatesSortOrderAsc ListApprovalTemplatesSortOrderEnum = "ASC"
ListApprovalTemplatesSortOrderDesc ListApprovalTemplatesSortOrderEnum = "DESC"
)
func GetListApprovalTemplatesSortOrderEnumValues() []ListApprovalTemplatesSortOrderEnum
GetListApprovalTemplatesSortOrderEnumValues Enumerates the set of values for ListApprovalTemplatesSortOrderEnum
func GetMappingListApprovalTemplatesSortOrderEnum(val string) (ListApprovalTemplatesSortOrderEnum, bool)
GetMappingListApprovalTemplatesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListLockboxesLockboxPartnerEnum Enum with underlying type: string
type ListLockboxesLockboxPartnerEnum string
Set of constants representing the allowable values for ListLockboxesLockboxPartnerEnum
const (
ListLockboxesLockboxPartnerFaaas ListLockboxesLockboxPartnerEnum = "FAAAS"
ListLockboxesLockboxPartnerCanary ListLockboxesLockboxPartnerEnum = "CANARY"
)
func GetListLockboxesLockboxPartnerEnumValues() []ListLockboxesLockboxPartnerEnum
GetListLockboxesLockboxPartnerEnumValues Enumerates the set of values for ListLockboxesLockboxPartnerEnum
func GetMappingListLockboxesLockboxPartnerEnum(val string) (ListLockboxesLockboxPartnerEnum, bool)
GetMappingListLockboxesLockboxPartnerEnum performs case Insensitive comparison on enum value and return the desired enum
ListLockboxesRequest wrapper for the ListLockboxes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ListLockboxes.go.html to see an example of how to use ListLockboxesRequest.
type ListLockboxesRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState LockboxLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// unique Lockbox identifier
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The ID of the resource associated with the lockbox.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The name of the lockbox partner.
LockboxPartner ListLockboxesLockboxPartnerEnum `mandatory:"false" contributesTo:"query" name:"lockboxPartner" omitEmpty:"true"`
// The ID of the partner.
PartnerId *string `mandatory:"false" contributesTo:"query" name:"partnerId"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListLockboxesSortOrderEnum `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.
SortBy ListLockboxesSortByEnum `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 ListLockboxesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListLockboxesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListLockboxesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListLockboxesRequest) String() string
func (request ListLockboxesRequest) 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
ListLockboxesResponse wrapper for the ListLockboxes operation
type ListLockboxesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of LockboxCollection instances
LockboxCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListLockboxesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListLockboxesResponse) String() string
ListLockboxesSortByEnum Enum with underlying type: string
type ListLockboxesSortByEnum string
Set of constants representing the allowable values for ListLockboxesSortByEnum
const (
ListLockboxesSortByTimecreated ListLockboxesSortByEnum = "timeCreated"
ListLockboxesSortByDisplayname ListLockboxesSortByEnum = "displayName"
ListLockboxesSortById ListLockboxesSortByEnum = "id"
)
func GetListLockboxesSortByEnumValues() []ListLockboxesSortByEnum
GetListLockboxesSortByEnumValues Enumerates the set of values for ListLockboxesSortByEnum
func GetMappingListLockboxesSortByEnum(val string) (ListLockboxesSortByEnum, bool)
GetMappingListLockboxesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListLockboxesSortOrderEnum Enum with underlying type: string
type ListLockboxesSortOrderEnum string
Set of constants representing the allowable values for ListLockboxesSortOrderEnum
const (
ListLockboxesSortOrderAsc ListLockboxesSortOrderEnum = "ASC"
ListLockboxesSortOrderDesc ListLockboxesSortOrderEnum = "DESC"
)
func GetListLockboxesSortOrderEnumValues() []ListLockboxesSortOrderEnum
GetListLockboxesSortOrderEnumValues Enumerates the set of values for ListLockboxesSortOrderEnum
func GetMappingListLockboxesSortOrderEnum(val string) (ListLockboxesSortOrderEnum, bool)
GetMappingListLockboxesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/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"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
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 (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"`
// 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 (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/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"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
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 (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"`
// 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 (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/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:"false" contributesTo:"query" name:"compartmentId"`
// The ID of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only resources their lifecycleState matches the given OperationStatus.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The ID of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
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 (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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
Lockbox Description of Lockbox.
type Lockbox struct {
// Unique identifier that is immutable on creation
Id *string `mandatory:"true" json:"id"`
// Lockbox Identifier, can be renamed
DisplayName *string `mandatory:"true" json:"displayName"`
// Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The unique identifier (OCID) of associated resource that the lockbox is created for.
ResourceId *string `mandatory:"true" json:"resourceId"`
// The time the the Lockbox was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the Lockbox.
LifecycleState LockboxLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// 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:"true" 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:"true" json:"definedTags"`
// The unique identifier (OCID) of partner resource using this lockbox to lock a resource
PartnerId *string `mandatory:"false" json:"partnerId"`
// The unique identifier (OCID) of lockbox resource using to reference parent lockbox in hybrid oma setup
ParentLockboxId *string `mandatory:"false" json:"parentLockboxId"`
// Compartment Identifier
PartnerCompartmentId *string `mandatory:"false" json:"partnerCompartmentId"`
// The partner using this lockbox to lock a resource.
LockboxPartner LockboxPartnerEnum `mandatory:"false" json:"lockboxPartner,omitempty"`
// The time the Lockbox was updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
AccessContextAttributes *AccessContextAttributeCollection `mandatory:"false" json:"accessContextAttributes"`
// Approval template ID
ApprovalTemplateId *string `mandatory:"false" json:"approvalTemplateId"`
// The maximum amount of time operator has access to associated resources.
MaxAccessDuration *string `mandatory:"false" json:"maxAccessDuration"`
// 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"`
// 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 Lockbox) String() string
func (m Lockbox) 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
LockboxAutoApprovalStateEnum Enum with underlying type: string
type LockboxAutoApprovalStateEnum string
Set of constants representing the allowable values for LockboxAutoApprovalStateEnum
const (
LockboxAutoApprovalStateEnabled LockboxAutoApprovalStateEnum = "ENABLED"
LockboxAutoApprovalStateDisabled LockboxAutoApprovalStateEnum = "DISABLED"
)
func GetLockboxAutoApprovalStateEnumValues() []LockboxAutoApprovalStateEnum
GetLockboxAutoApprovalStateEnumValues Enumerates the set of values for LockboxAutoApprovalStateEnum
func GetMappingLockboxAutoApprovalStateEnum(val string) (LockboxAutoApprovalStateEnum, bool)
GetMappingLockboxAutoApprovalStateEnum performs case Insensitive comparison on enum value and return the desired enum
LockboxClient a client for Lockbox
type LockboxClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewLockboxClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client LockboxClient, err error)
NewLockboxClientWithConfigurationProvider Creates a new default Lockbox client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewLockboxClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client LockboxClient, err error)
NewLockboxClientWithOboToken Creates a new default Lockbox 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 LockboxClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancels the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()
func (client LockboxClient) ChangeApprovalTemplateCompartment(ctx context.Context, request ChangeApprovalTemplateCompartmentRequest) (response ChangeApprovalTemplateCompartmentResponse, err error)
ChangeApprovalTemplateCompartment Moves an ApprovalTemplate resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ChangeApprovalTemplateCompartment.go.html to see an example of how to use ChangeApprovalTemplateCompartment API. A default retry strategy applies to this operation ChangeApprovalTemplateCompartment()
func (client LockboxClient) ChangeLockboxCompartment(ctx context.Context, request ChangeLockboxCompartmentRequest) (response ChangeLockboxCompartmentResponse, err error)
ChangeLockboxCompartment Moves a Lockbox resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ChangeLockboxCompartment.go.html to see an example of how to use ChangeLockboxCompartment API. A default retry strategy applies to this operation ChangeLockboxCompartment()
func (client *LockboxClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client LockboxClient) CreateAccessRequest(ctx context.Context, request CreateAccessRequestRequest) (response CreateAccessRequestResponse, err error)
CreateAccessRequest Creates a new access request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/CreateAccessRequest.go.html to see an example of how to use CreateAccessRequest API. A default retry strategy applies to this operation CreateAccessRequest()
func (client LockboxClient) CreateApprovalTemplate(ctx context.Context, request CreateApprovalTemplateRequest) (response CreateApprovalTemplateResponse, err error)
CreateApprovalTemplate Creates a new approval template.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/CreateApprovalTemplate.go.html to see an example of how to use CreateApprovalTemplate API. A default retry strategy applies to this operation CreateApprovalTemplate()
func (client LockboxClient) CreateLockbox(ctx context.Context, request CreateLockboxRequest) (response CreateLockboxResponse, err error)
CreateLockbox Creates a new Lockbox.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/CreateLockbox.go.html to see an example of how to use CreateLockbox API. A default retry strategy applies to this operation CreateLockbox()
func (client LockboxClient) DeleteApprovalTemplate(ctx context.Context, request DeleteApprovalTemplateRequest) (response DeleteApprovalTemplateResponse, err error)
DeleteApprovalTemplate Deletes an ApprovalTemplate resource by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/DeleteApprovalTemplate.go.html to see an example of how to use DeleteApprovalTemplate API. A default retry strategy applies to this operation DeleteApprovalTemplate()
func (client LockboxClient) DeleteLockbox(ctx context.Context, request DeleteLockboxRequest) (response DeleteLockboxResponse, err error)
DeleteLockbox Deletes a Lockbox resource by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/DeleteLockbox.go.html to see an example of how to use DeleteLockbox API. A default retry strategy applies to this operation DeleteLockbox()
func (client LockboxClient) ExportAccessRequests(ctx context.Context, request ExportAccessRequestsRequest) (response ExportAccessRequestsResponse, err error)
ExportAccessRequests Exports a list of AccessRequestSummary objects within a compartment and during a specified time range in text format. You can filter the results by problem severity.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ExportAccessRequests.go.html to see an example of how to use ExportAccessRequests API. A default retry strategy applies to this operation ExportAccessRequests()
func (client LockboxClient) GetAccessMaterials(ctx context.Context, request GetAccessMaterialsRequest) (response GetAccessMaterialsResponse, err error)
GetAccessMaterials Retrieves the access credential/material associated with the access request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/GetAccessMaterials.go.html to see an example of how to use GetAccessMaterials API. A default retry strategy applies to this operation GetAccessMaterials()
func (client LockboxClient) GetAccessRequest(ctx context.Context, request GetAccessRequestRequest) (response GetAccessRequestResponse, err error)
GetAccessRequest Retrieves an access request identified by the access request ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/GetAccessRequest.go.html to see an example of how to use GetAccessRequest API. A default retry strategy applies to this operation GetAccessRequest()
func (client LockboxClient) GetAccessRequestInternal(ctx context.Context, request GetAccessRequestInternalRequest) (response GetAccessRequestInternalResponse, err error)
GetAccessRequestInternal Retrieves an access request identified by the access request ID for internal use.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/GetAccessRequestInternal.go.html to see an example of how to use GetAccessRequestInternal API. A default retry strategy applies to this operation GetAccessRequestInternal()
func (client LockboxClient) GetApprovalTemplate(ctx context.Context, request GetApprovalTemplateRequest) (response GetApprovalTemplateResponse, err error)
GetApprovalTemplate Retrieves an approval template identified by the approval template ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/GetApprovalTemplate.go.html to see an example of how to use GetApprovalTemplate API. A default retry strategy applies to this operation GetApprovalTemplate()
func (client LockboxClient) GetLockbox(ctx context.Context, request GetLockboxRequest) (response GetLockboxResponse, err error)
GetLockbox Gets a Lockbox by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/GetLockbox.go.html to see an example of how to use GetLockbox API. A default retry strategy applies to this operation GetLockbox()
func (client LockboxClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets details of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client LockboxClient) HandleAccessRequest(ctx context.Context, request HandleAccessRequestRequest) (response HandleAccessRequestResponse, err error)
HandleAccessRequest Handle the AccessRequest
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/HandleAccessRequest.go.html to see an example of how to use HandleAccessRequest API. A default retry strategy applies to this operation HandleAccessRequest()
func (client LockboxClient) ListAccessRequests(ctx context.Context, request ListAccessRequestsRequest) (response ListAccessRequestsResponse, err error)
ListAccessRequests Retrieves a list of AccessRequestSummary objects in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ListAccessRequests.go.html to see an example of how to use ListAccessRequests API. A default retry strategy applies to this operation ListAccessRequests()
func (client LockboxClient) ListApprovalTemplates(ctx context.Context, request ListApprovalTemplatesRequest) (response ListApprovalTemplatesResponse, err error)
ListApprovalTemplates Retrieves a list of ApprovalTemplateSummary objects in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ListApprovalTemplates.go.html to see an example of how to use ListApprovalTemplates API. A default retry strategy applies to this operation ListApprovalTemplates()
func (client LockboxClient) ListLockboxes(ctx context.Context, request ListLockboxesRequest) (response ListLockboxesResponse, err error)
ListLockboxes Returns a list of Lockboxes.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ListLockboxes.go.html to see an example of how to use ListLockboxes API. A default retry strategy applies to this operation ListLockboxes()
func (client LockboxClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a (paginated) list of errors for the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client LockboxClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a (paginated) list of logs for the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client LockboxClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *LockboxClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client LockboxClient) UpdateApprovalTemplate(ctx context.Context, request UpdateApprovalTemplateRequest) (response UpdateApprovalTemplateResponse, err error)
UpdateApprovalTemplate Updates the ApprovalTemplate
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/UpdateApprovalTemplate.go.html to see an example of how to use UpdateApprovalTemplate API. A default retry strategy applies to this operation UpdateApprovalTemplate()
func (client LockboxClient) UpdateLockbox(ctx context.Context, request UpdateLockboxRequest) (response UpdateLockboxResponse, err error)
UpdateLockbox Updates the Lockbox
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/UpdateLockbox.go.html to see an example of how to use UpdateLockbox API. A default retry strategy applies to this operation UpdateLockbox()
LockboxCollection Results of a lockbox search. Contains both LockboxSummary items and other information, such as metadata.
type LockboxCollection struct {
// List of lockboxes.
Items []LockboxSummary `mandatory:"true" json:"items"`
}
func (m LockboxCollection) String() string
func (m LockboxCollection) 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
LockboxLifecycleStateEnum Enum with underlying type: string
type LockboxLifecycleStateEnum string
Set of constants representing the allowable values for LockboxLifecycleStateEnum
const (
LockboxLifecycleStateActive LockboxLifecycleStateEnum = "ACTIVE"
LockboxLifecycleStateCreating LockboxLifecycleStateEnum = "CREATING"
LockboxLifecycleStateUpdating LockboxLifecycleStateEnum = "UPDATING"
LockboxLifecycleStateDeleting LockboxLifecycleStateEnum = "DELETING"
LockboxLifecycleStateDeleted LockboxLifecycleStateEnum = "DELETED"
LockboxLifecycleStateFailed LockboxLifecycleStateEnum = "FAILED"
)
func GetLockboxLifecycleStateEnumValues() []LockboxLifecycleStateEnum
GetLockboxLifecycleStateEnumValues Enumerates the set of values for LockboxLifecycleStateEnum
func GetMappingLockboxLifecycleStateEnum(val string) (LockboxLifecycleStateEnum, bool)
GetMappingLockboxLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
LockboxPartnerEnum Enum with underlying type: string
type LockboxPartnerEnum string
Set of constants representing the allowable values for LockboxPartnerEnum
const (
LockboxPartnerFaaas LockboxPartnerEnum = "FAAAS"
LockboxPartnerCanary LockboxPartnerEnum = "CANARY"
)
func GetLockboxPartnerEnumValues() []LockboxPartnerEnum
GetLockboxPartnerEnumValues Enumerates the set of values for LockboxPartnerEnum
func GetMappingLockboxPartnerEnum(val string) (LockboxPartnerEnum, bool)
GetMappingLockboxPartnerEnum performs case Insensitive comparison on enum value and return the desired enum
LockboxSummary Summary of the Lockbox.
type LockboxSummary struct {
// Unique identifier that is immutable on creation
Id *string `mandatory:"true" json:"id"`
// Lockbox Identifier, can be renamed
DisplayName *string `mandatory:"true" json:"displayName"`
// Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The unique identifier (OCID) of associated resource that the lockbox is created for.
ResourceId *string `mandatory:"true" json:"resourceId"`
// The time the the Lockbox was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the Lockbox.
LifecycleState LockboxLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// 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:"true" 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:"true" json:"definedTags"`
// The partner using this lockbox to lock a resource.
LockboxPartner LockboxPartnerEnum `mandatory:"false" json:"lockboxPartner,omitempty"`
// The unique identifier (OCID) of partner resource using this lockbox to lock a resource
PartnerId *string `mandatory:"false" json:"partnerId"`
// Compartment Identifier
PartnerCompartmentId *string `mandatory:"false" json:"partnerCompartmentId"`
// Approval template ID
ApprovalTemplateId *string `mandatory:"false" json:"approvalTemplateId"`
// The maximum amount of time operator has access to associated resources.
MaxAccessDuration *string `mandatory:"false" json:"maxAccessDuration"`
// The time the Lockbox was updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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"`
// 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 LockboxSummary) String() string
func (m LockboxSummary) 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
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"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateLockbox OperationTypeEnum = "CREATE_LOCKBOX"
OperationTypeUpdateLockbox OperationTypeEnum = "UPDATE_LOCKBOX"
OperationTypeDeleteLockbox OperationTypeEnum = "DELETE_LOCKBOX"
OperationTypeMoveLockbox OperationTypeEnum = "MOVE_LOCKBOX"
OperationTypeCreateAccessRequest OperationTypeEnum = "CREATE_ACCESS_REQUEST"
OperationTypeApproveAccessRequest OperationTypeEnum = "APPROVE_ACCESS_REQUEST"
OperationTypeRevokeAccessRequest OperationTypeEnum = "REVOKE_ACCESS_REQUEST"
OperationTypeCreateApprovalTemplate OperationTypeEnum = "CREATE_APPROVAL_TEMPLATE"
OperationTypeMoveApprovalTemplate OperationTypeEnum = "MOVE_APPROVAL_TEMPLATE"
OperationTypeUpdateApprovalTemplate OperationTypeEnum = "UPDATE_APPROVAL_TEMPLATE"
OperationTypeDeleteApprovalTemplate OperationTypeEnum = "DELETE_APPROVAL_TEMPLATE"
OperationTypeCreatePartner OperationTypeEnum = "CREATE_PARTNER"
OperationTypeRemindAccessRequest OperationTypeEnum = "REMIND_ACCESS_REQUEST"
OperationTypeCreateAccesscontextattribute OperationTypeEnum = "CREATE_ACCESSCONTEXTATTRIBUTE"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
PersonaLevelEnum Enum with underlying type: string
type PersonaLevelEnum string
Set of constants representing the allowable values for PersonaLevelEnum
const (
PersonaLevelLevel1 PersonaLevelEnum = "LEVEL1"
PersonaLevelLevel2 PersonaLevelEnum = "LEVEL2"
PersonaLevelLevel3 PersonaLevelEnum = "LEVEL3"
PersonaLevelAdmin PersonaLevelEnum = "ADMIN"
PersonaLevelOperator PersonaLevelEnum = "OPERATOR"
)
func GetMappingPersonaLevelEnum(val string) (PersonaLevelEnum, bool)
GetMappingPersonaLevelEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPersonaLevelEnumValues() []PersonaLevelEnum
GetPersonaLevelEnumValues Enumerates the set of values for PersonaLevelEnum
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(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
UpdateApprovalTemplateDetails The action to be updated.
type UpdateApprovalTemplateDetails struct {
ApproverLevels *ApproverLevels `mandatory:"false" json:"approverLevels"`
// approval template identifier
DisplayName *string `mandatory:"false" json:"displayName"`
// The auto approval state of the lockbox.
AutoApprovalState LockboxAutoApprovalStateEnum `mandatory:"false" json:"autoApprovalState,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"`
}
func (m UpdateApprovalTemplateDetails) String() string
func (m UpdateApprovalTemplateDetails) 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
UpdateApprovalTemplateRequest wrapper for the UpdateApprovalTemplate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/UpdateApprovalTemplate.go.html to see an example of how to use UpdateApprovalTemplateRequest.
type UpdateApprovalTemplateRequest struct {
// The unique identifier (OCID) of the approval template.
ApprovalTemplateId *string `mandatory:"true" contributesTo:"path" name:"approvalTemplateId"`
// The information to be updated.
UpdateApprovalTemplateDetails `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 UpdateApprovalTemplateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateApprovalTemplateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateApprovalTemplateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateApprovalTemplateRequest) String() string
func (request UpdateApprovalTemplateRequest) 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
UpdateApprovalTemplateResponse wrapper for the UpdateApprovalTemplate operation
type UpdateApprovalTemplateResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApprovalTemplate instance
ApprovalTemplate `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateApprovalTemplateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateApprovalTemplateResponse) String() string
UpdateLockboxDetails The information to be updated.
type UpdateLockboxDetails struct {
// Lockbox Identifier
DisplayName *string `mandatory:"false" json:"displayName"`
// Approval template ID
ApprovalTemplateId *string `mandatory:"false" json:"approvalTemplateId"`
// The maximum amount of time operator has access to associated resources.
MaxAccessDuration *string `mandatory:"false" json:"maxAccessDuration"`
// 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 (m UpdateLockboxDetails) String() string
func (m UpdateLockboxDetails) 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
UpdateLockboxRequest wrapper for the UpdateLockbox operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/UpdateLockbox.go.html to see an example of how to use UpdateLockboxRequest.
type UpdateLockboxRequest struct {
// unique Lockbox identifier
LockboxId *string `mandatory:"true" contributesTo:"path" name:"lockboxId"`
// The information to be updated.
UpdateLockboxDetails `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 UpdateLockboxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateLockboxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateLockboxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateLockboxRequest) String() string
func (request UpdateLockboxRequest) 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
UpdateLockboxResponse wrapper for the UpdateLockbox operation
type UpdateLockboxResponse struct {
// The underlying http response
RawResponse *http.Response
// The Lockbox instance
Lockbox `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateLockboxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateLockboxResponse) String() string
WorkRequest A description of workrequest status
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 (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed on
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
type WorkRequestErrorCollection struct {
// List of workRequestError objects.
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 A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// List of workRequestLogEntries.
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
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"`
// Additional information that helps to explain the resource.
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
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
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum
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 (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 Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// List 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