func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetApiMetadataLifecycleStateEnumStringValues() []string
GetApiMetadataLifecycleStateEnumStringValues Enumerates the set of values in String for ApiMetadataLifecycleStateEnum
func GetListApiMetadataByEntityTypesSortByEnumStringValues() []string
GetListApiMetadataByEntityTypesSortByEnumStringValues Enumerates the set of values in String for ListApiMetadataByEntityTypesSortByEnum
func GetListApiMetadataByEntityTypesSortOrderEnumStringValues() []string
GetListApiMetadataByEntityTypesSortOrderEnumStringValues Enumerates the set of values in String for ListApiMetadataByEntityTypesSortOrderEnum
func GetListApiMetadataSortByEnumStringValues() []string
GetListApiMetadataSortByEnumStringValues Enumerates the set of values in String for ListApiMetadataSortByEnum
func GetListApiMetadataSortOrderEnumStringValues() []string
GetListApiMetadataSortOrderEnumStringValues Enumerates the set of values in String for ListApiMetadataSortOrderEnum
func GetListPrivilegedApiControlsSortByEnumStringValues() []string
GetListPrivilegedApiControlsSortByEnumStringValues Enumerates the set of values in String for ListPrivilegedApiControlsSortByEnum
func GetListPrivilegedApiControlsSortOrderEnumStringValues() []string
GetListPrivilegedApiControlsSortOrderEnumStringValues Enumerates the set of values in String for ListPrivilegedApiControlsSortOrderEnum
func GetListPrivilegedApiRequestsSortByEnumStringValues() []string
GetListPrivilegedApiRequestsSortByEnumStringValues Enumerates the set of values in String for ListPrivilegedApiRequestsSortByEnum
func GetListPrivilegedApiRequestsSortOrderEnumStringValues() []string
GetListPrivilegedApiRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListPrivilegedApiRequestsSortOrderEnum
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 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 GetPrivilegedApiControlLifecycleStateEnumStringValues() []string
GetPrivilegedApiControlLifecycleStateEnumStringValues Enumerates the set of values in String for PrivilegedApiControlLifecycleStateEnum
func GetPrivilegedApiRequestLifecycleStateEnumStringValues() []string
GetPrivilegedApiRequestLifecycleStateEnumStringValues Enumerates the set of values in String for PrivilegedApiRequestLifecycleStateEnum
func GetPrivilegedApiRequestSeverityEnumStringValues() []string
GetPrivilegedApiRequestSeverityEnumStringValues Enumerates the set of values in String for PrivilegedApiRequestSeverityEnum
func GetPrivilegedApiRequestStateEnumStringValues() []string
GetPrivilegedApiRequestStateEnumStringValues Enumerates the set of values in String for PrivilegedApiRequestStateEnum
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
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
ApiMetadata An ApiDetail contains details such as the service it belongs to, the name of the api, the type of api, and the parameters of the api if it contains. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type ApiMetadata struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ApiDetail.
Id *string `mandatory:"true" json:"id"`
// The operation Name of the api. The name must be unique.
DisplayName *string `mandatory:"true" json:"displayName"`
// The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the ApiMetadata.
LifecycleState ApiMetadataLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The service Name to which the api belongs to.
ServiceName *string `mandatory:"false" json:"serviceName"`
// rest path of the api.
Path *string `mandatory:"false" json:"path"`
// ResourceType to which the apiMetadata belongs to.
EntityType *string `mandatory:"false" json:"entityType"`
// The name of the api to execute the api request.
ApiName *string `mandatory:"false" json:"apiName"`
// List of the fields that is use while calling post or put for the data.
Fields []string `mandatory:"false" json:"fields"`
// The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeDeleted *common.SDKTime `mandatory:"false" json:"timeDeleted"`
// A message that describes the current state of the ApiMetadata in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ApiMetadata) String() string
func (m ApiMetadata) 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
ApiMetadataByEntityTypeCollection Results of a api search.
type ApiMetadataByEntityTypeCollection struct {
// List of apiMetadataByEntityTypeSummary.
Items []ApiMetadataByEntityTypeSummary `mandatory:"true" json:"items"`
}
func (m ApiMetadataByEntityTypeCollection) String() string
func (m ApiMetadataByEntityTypeCollection) 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
ApiMetadataByEntityTypeSummary Summary information about a ApiMetadata.
type ApiMetadataByEntityTypeSummary struct {
// The entity Type to which the Api belongs to.
EntityType *string `mandatory:"false" json:"entityType"`
// List of apiMetadataSummary.
ApiMetadatas []ApiMetadataSummary `mandatory:"false" json:"apiMetadatas"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ApiMetadataByEntityTypeSummary) String() string
func (m ApiMetadataByEntityTypeSummary) 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
ApiMetadataClient a client for ApiMetadata
type ApiMetadataClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewApiMetadataClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ApiMetadataClient, err error)
NewApiMetadataClientWithConfigurationProvider Creates a new default ApiMetadata client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewApiMetadataClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ApiMetadataClient, err error)
NewApiMetadataClientWithOboToken Creates a new default ApiMetadata 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 *ApiMetadataClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ApiMetadataClient) GetApiMetadata(ctx context.Context, request GetApiMetadataRequest) (response GetApiMetadataResponse, err error)
GetApiMetadata Gets information about a ApiMetadata.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/GetApiMetadata.go.html to see an example of how to use GetApiMetadata API. A default retry strategy applies to this operation GetApiMetadata()
func (client ApiMetadataClient) ListApiMetadata(ctx context.Context, request ListApiMetadataRequest) (response ListApiMetadataResponse, err error)
ListApiMetadata Gets a list of ApiMetadata.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ListApiMetadata.go.html to see an example of how to use ListApiMetadata API. A default retry strategy applies to this operation ListApiMetadata()
func (client ApiMetadataClient) ListApiMetadataByEntityTypes(ctx context.Context, request ListApiMetadataByEntityTypesRequest) (response ListApiMetadataByEntityTypesResponse, err error)
ListApiMetadataByEntityTypes Gets a list of ApiMetadata Grouped By Entity Types.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ListApiMetadataByEntityTypes.go.html to see an example of how to use ListApiMetadataByEntityTypes API. A default retry strategy applies to this operation ListApiMetadataByEntityTypes()
func (client *ApiMetadataClient) SetRegion(region string)
SetRegion overrides the region of this client.
ApiMetadataCollection Results of a api search.
type ApiMetadataCollection struct {
// List of apiMetadataSummary.
Items []ApiMetadataSummary `mandatory:"true" json:"items"`
}
func (m ApiMetadataCollection) String() string
func (m ApiMetadataCollection) 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
ApiMetadataLifecycleStateEnum Enum with underlying type: string
type ApiMetadataLifecycleStateEnum string
Set of constants representing the allowable values for ApiMetadataLifecycleStateEnum
const (
ApiMetadataLifecycleStateCreating ApiMetadataLifecycleStateEnum = "CREATING"
ApiMetadataLifecycleStateUpdating ApiMetadataLifecycleStateEnum = "UPDATING"
ApiMetadataLifecycleStateActive ApiMetadataLifecycleStateEnum = "ACTIVE"
ApiMetadataLifecycleStateDeleting ApiMetadataLifecycleStateEnum = "DELETING"
ApiMetadataLifecycleStateDeleted ApiMetadataLifecycleStateEnum = "DELETED"
ApiMetadataLifecycleStateFailed ApiMetadataLifecycleStateEnum = "FAILED"
)
func GetApiMetadataLifecycleStateEnumValues() []ApiMetadataLifecycleStateEnum
GetApiMetadataLifecycleStateEnumValues Enumerates the set of values for ApiMetadataLifecycleStateEnum
func GetMappingApiMetadataLifecycleStateEnum(val string) (ApiMetadataLifecycleStateEnum, bool)
GetMappingApiMetadataLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ApiMetadataSummary Summary information about a ApiMetadata.
type ApiMetadataSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ApiDetail.
Id *string `mandatory:"true" json:"id"`
// Name of the Api.
DisplayName *string `mandatory:"true" json:"displayName"`
// The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the ApiMetadata.
LifecycleState ApiMetadataLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The service Name to which the Api belongs to.
ServiceName *string `mandatory:"false" json:"serviceName"`
// EntityType to which the apiMetadata belongs to.
EntityType *string `mandatory:"false" json:"entityType"`
// The name of the api to execute the api request.
ApiName *string `mandatory:"false" json:"apiName"`
// List of the fields that is use while calling post or put for the data.
Attributes []string `mandatory:"false" json:"attributes"`
// The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the ApiMetadata in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ApiMetadataSummary) String() string
func (m ApiMetadataSummary) 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
ApprovePrivilegedApiRequestDetails Details of the privilegedApi request approval such as when the approver approved and any comment provided by the approver.
type ApprovePrivilegedApiRequestDetails struct {
// Comment by the approver during approval.
ApproverComment *string `mandatory:"false" json:"approverComment"`
// The time when access request is scheduled to be approved in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z'
TimeOfUserCreation *common.SDKTime `mandatory:"false" json:"timeOfUserCreation"`
}
func (m ApprovePrivilegedApiRequestDetails) String() string
func (m ApprovePrivilegedApiRequestDetails) 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
ApprovePrivilegedApiRequestRequest wrapper for the ApprovePrivilegedApiRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ApprovePrivilegedApiRequest.go.html to see an example of how to use ApprovePrivilegedApiRequestRequest.
type ApprovePrivilegedApiRequestRequest struct {
// unique PrivilegedApiRequest identifier
PrivilegedApiRequestId *string `mandatory:"true" contributesTo:"path" name:"privilegedApiRequestId"`
// Details regarding the approval of an privilegedApi request created by the operator.
ApprovePrivilegedApiRequestDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 running 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 removed 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 ApprovePrivilegedApiRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ApprovePrivilegedApiRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ApprovePrivilegedApiRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ApprovePrivilegedApiRequestRequest) String() string
func (request ApprovePrivilegedApiRequestRequest) 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
ApprovePrivilegedApiRequestResponse wrapper for the ApprovePrivilegedApiRequest operation
type ApprovePrivilegedApiRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 ApprovePrivilegedApiRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ApprovePrivilegedApiRequestResponse) String() string
ApproverDetail It contains appprovers details such as who approved it, when he approved and any details the approver would have entered as a part of approval process.
type ApproverDetail struct {
// The userId of the approver.
ApproverId *string `mandatory:"false" json:"approverId"`
// The action done by the approver.
ApprovalAction *string `mandatory:"false" json:"approvalAction"`
// Comment specified by the approver of the request.
ApprovalComment *string `mandatory:"false" json:"approvalComment"`
// Time when the privilegedApi request was authorized by the customer in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z'
TimeOfAuthorization *common.SDKTime `mandatory:"false" json:"timeOfAuthorization"`
// Time for when the privilegedApi request should start that is authorized by the customer in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z'
TimeApprovedForAccess *common.SDKTime `mandatory:"false" json:"timeApprovedForAccess"`
}
func (m ApproverDetail) String() string
func (m ApproverDetail) 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
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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
ChangePrivilegedApiControlCompartmentDetails The configuration details for the move operation.
type ChangePrivilegedApiControlCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the PrivilegedApiControl to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangePrivilegedApiControlCompartmentDetails) String() string
func (m ChangePrivilegedApiControlCompartmentDetails) 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
ChangePrivilegedApiControlCompartmentRequest wrapper for the ChangePrivilegedApiControlCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ChangePrivilegedApiControlCompartment.go.html to see an example of how to use ChangePrivilegedApiControlCompartmentRequest.
type ChangePrivilegedApiControlCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivilegedApiControl.
PrivilegedApiControlId *string `mandatory:"true" contributesTo:"path" name:"privilegedApiControlId"`
// The information to be updated.
ChangePrivilegedApiControlCompartmentDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 running 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 removed 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 ChangePrivilegedApiControlCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangePrivilegedApiControlCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangePrivilegedApiControlCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangePrivilegedApiControlCompartmentRequest) String() string
func (request ChangePrivilegedApiControlCompartmentRequest) 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
ChangePrivilegedApiControlCompartmentResponse wrapper for the ChangePrivilegedApiControlCompartment operation
type ChangePrivilegedApiControlCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 ChangePrivilegedApiControlCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangePrivilegedApiControlCompartmentResponse) String() string
ClosePrivilegedApiRequestDetails The information about closing PrivilegedApiRequest.
type ClosePrivilegedApiRequestDetails struct {
// description about why the request is closed
Description *string `mandatory:"false" json:"description"`
}
func (m ClosePrivilegedApiRequestDetails) String() string
func (m ClosePrivilegedApiRequestDetails) 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
ClosePrivilegedApiRequestRequest wrapper for the ClosePrivilegedApiRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ClosePrivilegedApiRequest.go.html to see an example of how to use ClosePrivilegedApiRequestRequest.
type ClosePrivilegedApiRequestRequest struct {
// unique PrivilegedApiRequest identifier
PrivilegedApiRequestId *string `mandatory:"true" contributesTo:"path" name:"privilegedApiRequestId"`
// Details regarding the close of an privilegedApi request created by the operator.
ClosePrivilegedApiRequestDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 running 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 removed 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 ClosePrivilegedApiRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ClosePrivilegedApiRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ClosePrivilegedApiRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ClosePrivilegedApiRequestRequest) String() string
func (request ClosePrivilegedApiRequestRequest) 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
ClosePrivilegedApiRequestResponse wrapper for the ClosePrivilegedApiRequest operation
type ClosePrivilegedApiRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 ClosePrivilegedApiRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ClosePrivilegedApiRequestResponse) String() string
CreatePrivilegedApiControlDetails The data to create a PrivilegedApiControl.
type CreatePrivilegedApiControlDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the PrivilegedApiControl in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the OCI Notification topic to publish messages related to this Delegation Control.
NotificationTopicId *string `mandatory:"true" json:"notificationTopicId"`
// List of user IAM group ids who can approve an privilegedApi request associated with a resource governed by this operator control.
ApproverGroupIdList []string `mandatory:"true" json:"approverGroupIdList"`
// List of privileged operator operations. If Privileged API Managment is enabled for a resource it will be validated whether the operation done by the operator is a part of privileged operation.
PrivilegedOperationList []PrivilegedApiDetails `mandatory:"true" json:"privilegedOperationList"`
// resourceType for which the PrivilegedApiControl is applicable
ResourceType *string `mandatory:"true" json:"resourceType"`
// contains Resource details
Resources []string `mandatory:"true" json:"resources"`
// Name of the privilegedApi control It has to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the privilegedApi control.
Description *string `mandatory:"false" json:"description"`
// Number of approvers required to approve an privilegedApi request.
NumberOfApprovers *int `mandatory:"false" json:"numberOfApprovers"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreatePrivilegedApiControlDetails) String() string
func (m CreatePrivilegedApiControlDetails) 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
CreatePrivilegedApiControlRequest wrapper for the CreatePrivilegedApiControl operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/CreatePrivilegedApiControl.go.html to see an example of how to use CreatePrivilegedApiControlRequest.
type CreatePrivilegedApiControlRequest struct {
// Details for the new PrivilegedApiControl.
CreatePrivilegedApiControlDetails `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 running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 CreatePrivilegedApiControlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePrivilegedApiControlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePrivilegedApiControlRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePrivilegedApiControlRequest) String() string
func (request CreatePrivilegedApiControlRequest) 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
CreatePrivilegedApiControlResponse wrapper for the CreatePrivilegedApiControl operation
type CreatePrivilegedApiControlResponse struct {
// The underlying http response
RawResponse *http.Response
// The PrivilegedApiControl instance
PrivilegedApiControl `presentIn:"body"`
// URL for the created privilegedApiControl. The privilegedApiControl OCID is generated after this request is sent.
Location *string `presentIn:"header" name:"location"`
// Same as location.
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 CreatePrivilegedApiControlResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePrivilegedApiControlResponse) String() string
CreatePrivilegedApiRequestDetails An Oracle operator raises privilegedApi request when they need access to any infrastructure resource governed by PrivilegedApi Access Control.
The privilegedApi request identifies the target resource and the set of operator actions. Access request handling depends upon the Operator Control that governs the target resource, and the set of operator actions listed for approval in the access request. If all of the operator actions listed in the privilegedApi request are in the pre-approved list in the PrivilegedApi Control that governs the target resource, then the privilegedApi request is automatically approved. If not, then the privilegedApi request requires explicit approval from the approver group specified by the PrivilegedApi Control governing the target resource.
You can approve or reject an privilegedApi request. You can also revoke the approval of an already approved privilegedApi request. While creating an access request,
the operator specifies the duration of access. You have the option to approve the entire duration or reduce or even increase the time duration. An operator can also request for an extension. The approval for such an extension is processed the same way the original privilegedApi request was processed.
type CreatePrivilegedApiRequestDetails struct {
// Summary comment by the operator creating the access request.
ReasonSummary *string `mandatory:"true" json:"reasonSummary"`
// The OCID of the target resource associated with the access request. The operator raises an access request to get approval to access the target resource.
ResourceId *string `mandatory:"true" json:"resourceId"`
// List of api names, attributes for which approval is sought by the user.
PrivilegedOperationList []PrivilegedApiRequestOperationDetails `mandatory:"true" json:"privilegedOperationList"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The subresource names requested for approval.
SubResourceNameList []string `mandatory:"false" json:"subResourceNameList"`
// The OCID of the OCI Notification topic to publish messages related to this Privileged Api Request.
NotificationTopicId *string `mandatory:"false" json:"notificationTopicId"`
// Reason in detail for which the operator is requesting access on the target resource.
ReasonDetail *string `mandatory:"false" json:"reasonDetail"`
// Priority assigned to the access request by the operator
Severity PrivilegedApiRequestSeverityEnum `mandatory:"false" json:"severity,omitempty"`
// Duration in hours for which access is sought on the target resource.
DurationInHrs *int `mandatory:"false" json:"durationInHrs"`
// A list of ticket numbers related to this Privileged Api Access Request, e.g. Service Request (SR) number and JIRA ticket number.
TicketNumbers []string `mandatory:"false" json:"ticketNumbers"`
// Time in future when the user for the privilegedApi request needs to be created in RFC 3339 (https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z'
TimeRequestedForFutureAccess *common.SDKTime `mandatory:"false" json:"timeRequestedForFutureAccess"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreatePrivilegedApiRequestDetails) String() string
func (m CreatePrivilegedApiRequestDetails) 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
CreatePrivilegedApiRequestRequest wrapper for the CreatePrivilegedApiRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/CreatePrivilegedApiRequest.go.html to see an example of how to use CreatePrivilegedApiRequestRequest.
type CreatePrivilegedApiRequestRequest struct {
// Details for the new PrivilegedApiRequest.
CreatePrivilegedApiRequestDetails `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 running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 CreatePrivilegedApiRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePrivilegedApiRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePrivilegedApiRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePrivilegedApiRequestRequest) String() string
func (request CreatePrivilegedApiRequestRequest) 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
CreatePrivilegedApiRequestResponse wrapper for the CreatePrivilegedApiRequest operation
type CreatePrivilegedApiRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The PrivilegedApiRequest instance
PrivilegedApiRequest `presentIn:"body"`
// URL for the created privilegedApiRequest. The privilegedApiRequest OCID is generated after this request is sent.
Location *string `presentIn:"header" name:"location"`
// Same as location.
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 CreatePrivilegedApiRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePrivilegedApiRequestResponse) String() string
DeletePrivilegedApiControlRequest wrapper for the DeletePrivilegedApiControl operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/DeletePrivilegedApiControl.go.html to see an example of how to use DeletePrivilegedApiControlRequest.
type DeletePrivilegedApiControlRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivilegedApiControl.
PrivilegedApiControlId *string `mandatory:"true" contributesTo:"path" name:"privilegedApiControlId"`
// reason for deletion of PrivilegedApiControl.
Description *string `mandatory:"false" contributesTo:"query" name:"description"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 DeletePrivilegedApiControlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePrivilegedApiControlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePrivilegedApiControlRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePrivilegedApiControlRequest) String() string
func (request DeletePrivilegedApiControlRequest) 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
DeletePrivilegedApiControlResponse wrapper for the DeletePrivilegedApiControl operation
type DeletePrivilegedApiControlResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 DeletePrivilegedApiControlResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePrivilegedApiControlResponse) String() string
GetApiMetadataRequest wrapper for the GetApiMetadata operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/GetApiMetadata.go.html to see an example of how to use GetApiMetadataRequest.
type GetApiMetadataRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivilegedApiControl.
ApiMetadataId *string `mandatory:"true" contributesTo:"path" name:"apiMetadataId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetApiMetadataRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetApiMetadataRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetApiMetadataRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetApiMetadataRequest) String() string
func (request GetApiMetadataRequest) 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
GetApiMetadataResponse wrapper for the GetApiMetadata operation
type GetApiMetadataResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApiMetadata instance
ApiMetadata `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 GetApiMetadataResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetApiMetadataResponse) String() string
GetPrivilegedApiControlRequest wrapper for the GetPrivilegedApiControl operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/GetPrivilegedApiControl.go.html to see an example of how to use GetPrivilegedApiControlRequest.
type GetPrivilegedApiControlRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivilegedApiControl.
PrivilegedApiControlId *string `mandatory:"true" contributesTo:"path" name:"privilegedApiControlId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetPrivilegedApiControlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPrivilegedApiControlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPrivilegedApiControlRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPrivilegedApiControlRequest) String() string
func (request GetPrivilegedApiControlRequest) 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
GetPrivilegedApiControlResponse wrapper for the GetPrivilegedApiControl operation
type GetPrivilegedApiControlResponse struct {
// The underlying http response
RawResponse *http.Response
// The PrivilegedApiControl instance
PrivilegedApiControl `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 GetPrivilegedApiControlResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPrivilegedApiControlResponse) String() string
GetPrivilegedApiRequestRequest wrapper for the GetPrivilegedApiRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/GetPrivilegedApiRequest.go.html to see an example of how to use GetPrivilegedApiRequestRequest.
type GetPrivilegedApiRequestRequest struct {
// unique PrivilegedApiRequest identifier
PrivilegedApiRequestId *string `mandatory:"true" contributesTo:"path" name:"privilegedApiRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetPrivilegedApiRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPrivilegedApiRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPrivilegedApiRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPrivilegedApiRequestRequest) String() string
func (request GetPrivilegedApiRequestRequest) 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
GetPrivilegedApiRequestResponse wrapper for the GetPrivilegedApiRequest operation
type GetPrivilegedApiRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The PrivilegedApiRequest instance
PrivilegedApiRequest `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 GetPrivilegedApiRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPrivilegedApiRequestResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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
ListApiMetadataByEntityTypesRequest wrapper for the ListApiMetadataByEntityTypes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ListApiMetadataByEntityTypes.go.html to see an example of how to use ListApiMetadataByEntityTypesRequest.
type ListApiMetadataByEntityTypesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the given lifecycle state. The
// state value is case-insensitive.
LifecycleState ApiMetadataLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only lists of resources that match the entire given service type.
ResourceType *string `mandatory:"false" contributesTo:"query" name:"resourceType"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListApiMetadataByEntityTypesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
// is descending. Default order for `displayName` is ascending.
SortBy ListApiMetadataByEntityTypesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ListApiMetadataByEntityTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListApiMetadataByEntityTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListApiMetadataByEntityTypesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListApiMetadataByEntityTypesRequest) String() string
func (request ListApiMetadataByEntityTypesRequest) 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
ListApiMetadataByEntityTypesResponse wrapper for the ListApiMetadataByEntityTypes operation
type ListApiMetadataByEntityTypesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ApiMetadataByEntityTypeCollection instances
ApiMetadataByEntityTypeCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListApiMetadataByEntityTypesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListApiMetadataByEntityTypesResponse) String() string
ListApiMetadataByEntityTypesSortByEnum Enum with underlying type: string
type ListApiMetadataByEntityTypesSortByEnum string
Set of constants representing the allowable values for ListApiMetadataByEntityTypesSortByEnum
const (
ListApiMetadataByEntityTypesSortByTimecreated ListApiMetadataByEntityTypesSortByEnum = "timeCreated"
ListApiMetadataByEntityTypesSortByDisplayname ListApiMetadataByEntityTypesSortByEnum = "displayName"
)
func GetListApiMetadataByEntityTypesSortByEnumValues() []ListApiMetadataByEntityTypesSortByEnum
GetListApiMetadataByEntityTypesSortByEnumValues Enumerates the set of values for ListApiMetadataByEntityTypesSortByEnum
func GetMappingListApiMetadataByEntityTypesSortByEnum(val string) (ListApiMetadataByEntityTypesSortByEnum, bool)
GetMappingListApiMetadataByEntityTypesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListApiMetadataByEntityTypesSortOrderEnum Enum with underlying type: string
type ListApiMetadataByEntityTypesSortOrderEnum string
Set of constants representing the allowable values for ListApiMetadataByEntityTypesSortOrderEnum
const (
ListApiMetadataByEntityTypesSortOrderAsc ListApiMetadataByEntityTypesSortOrderEnum = "ASC"
ListApiMetadataByEntityTypesSortOrderDesc ListApiMetadataByEntityTypesSortOrderEnum = "DESC"
)
func GetListApiMetadataByEntityTypesSortOrderEnumValues() []ListApiMetadataByEntityTypesSortOrderEnum
GetListApiMetadataByEntityTypesSortOrderEnumValues Enumerates the set of values for ListApiMetadataByEntityTypesSortOrderEnum
func GetMappingListApiMetadataByEntityTypesSortOrderEnum(val string) (ListApiMetadataByEntityTypesSortOrderEnum, bool)
GetMappingListApiMetadataByEntityTypesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListApiMetadataRequest wrapper for the ListApiMetadata operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ListApiMetadata.go.html to see an example of how to use ListApiMetadataRequest.
type ListApiMetadataRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the given lifecycle state. The
// state value is case-insensitive.
LifecycleState ApiMetadataLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only lists of resources that match the entire given service type.
ResourceType *string `mandatory:"false" contributesTo:"query" name:"resourceType"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListApiMetadataSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
// is descending. Default order for `displayName` is ascending.
SortBy ListApiMetadataSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ListApiMetadataRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListApiMetadataRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListApiMetadataRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListApiMetadataRequest) String() string
func (request ListApiMetadataRequest) 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
ListApiMetadataResponse wrapper for the ListApiMetadata operation
type ListApiMetadataResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ApiMetadataCollection instances
ApiMetadataCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListApiMetadataResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListApiMetadataResponse) String() string
ListApiMetadataSortByEnum Enum with underlying type: string
type ListApiMetadataSortByEnum string
Set of constants representing the allowable values for ListApiMetadataSortByEnum
const (
ListApiMetadataSortByTimecreated ListApiMetadataSortByEnum = "timeCreated"
ListApiMetadataSortByDisplayname ListApiMetadataSortByEnum = "displayName"
)
func GetListApiMetadataSortByEnumValues() []ListApiMetadataSortByEnum
GetListApiMetadataSortByEnumValues Enumerates the set of values for ListApiMetadataSortByEnum
func GetMappingListApiMetadataSortByEnum(val string) (ListApiMetadataSortByEnum, bool)
GetMappingListApiMetadataSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListApiMetadataSortOrderEnum Enum with underlying type: string
type ListApiMetadataSortOrderEnum string
Set of constants representing the allowable values for ListApiMetadataSortOrderEnum
const (
ListApiMetadataSortOrderAsc ListApiMetadataSortOrderEnum = "ASC"
ListApiMetadataSortOrderDesc ListApiMetadataSortOrderEnum = "DESC"
)
func GetListApiMetadataSortOrderEnumValues() []ListApiMetadataSortOrderEnum
GetListApiMetadataSortOrderEnumValues Enumerates the set of values for ListApiMetadataSortOrderEnum
func GetMappingListApiMetadataSortOrderEnum(val string) (ListApiMetadataSortOrderEnum, bool)
GetMappingListApiMetadataSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPrivilegedApiControlsRequest wrapper for the ListPrivilegedApiControls operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ListPrivilegedApiControls.go.html to see an example of how to use ListPrivilegedApiControlsRequest.
type ListPrivilegedApiControlsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivilegedApiControl.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only resources that match the given lifecycle state. The
// state value is case-insensitive.
LifecycleState PrivilegedApiControlLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only lists of resources that match the entire given service type.
ResourceType *string `mandatory:"false" contributesTo:"query" name:"resourceType"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListPrivilegedApiControlsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
// is descending. Default order for `displayName` is ascending.
SortBy ListPrivilegedApiControlsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ListPrivilegedApiControlsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPrivilegedApiControlsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPrivilegedApiControlsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPrivilegedApiControlsRequest) String() string
func (request ListPrivilegedApiControlsRequest) 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
ListPrivilegedApiControlsResponse wrapper for the ListPrivilegedApiControls operation
type ListPrivilegedApiControlsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of PrivilegedApiControlCollection instances
PrivilegedApiControlCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListPrivilegedApiControlsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPrivilegedApiControlsResponse) String() string
ListPrivilegedApiControlsSortByEnum Enum with underlying type: string
type ListPrivilegedApiControlsSortByEnum string
Set of constants representing the allowable values for ListPrivilegedApiControlsSortByEnum
const (
ListPrivilegedApiControlsSortByTimecreated ListPrivilegedApiControlsSortByEnum = "timeCreated"
ListPrivilegedApiControlsSortByDisplayname ListPrivilegedApiControlsSortByEnum = "displayName"
)
func GetListPrivilegedApiControlsSortByEnumValues() []ListPrivilegedApiControlsSortByEnum
GetListPrivilegedApiControlsSortByEnumValues Enumerates the set of values for ListPrivilegedApiControlsSortByEnum
func GetMappingListPrivilegedApiControlsSortByEnum(val string) (ListPrivilegedApiControlsSortByEnum, bool)
GetMappingListPrivilegedApiControlsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPrivilegedApiControlsSortOrderEnum Enum with underlying type: string
type ListPrivilegedApiControlsSortOrderEnum string
Set of constants representing the allowable values for ListPrivilegedApiControlsSortOrderEnum
const (
ListPrivilegedApiControlsSortOrderAsc ListPrivilegedApiControlsSortOrderEnum = "ASC"
ListPrivilegedApiControlsSortOrderDesc ListPrivilegedApiControlsSortOrderEnum = "DESC"
)
func GetListPrivilegedApiControlsSortOrderEnumValues() []ListPrivilegedApiControlsSortOrderEnum
GetListPrivilegedApiControlsSortOrderEnumValues Enumerates the set of values for ListPrivilegedApiControlsSortOrderEnum
func GetMappingListPrivilegedApiControlsSortOrderEnum(val string) (ListPrivilegedApiControlsSortOrderEnum, bool)
GetMappingListPrivilegedApiControlsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPrivilegedApiRequestsRequest wrapper for the ListPrivilegedApiRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ListPrivilegedApiRequests.go.html to see an example of how to use ListPrivilegedApiRequestsRequest.
type ListPrivilegedApiRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivilegedApiRequest.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource .
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// A filter to return only lists of resources that match the entire given service type.
ResourceType *string `mandatory:"false" contributesTo:"query" name:"resourceType"`
// A filter to return only resources that match the given lifecycle state. The
// state value is case-insensitive.
LifecycleState PrivilegedApiRequestLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the state. The
// state value is case-insensitive.
State PrivilegedApiRequestStateEnum `mandatory:"false" contributesTo:"query" name:"state" omitEmpty:"true"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListPrivilegedApiRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
// is descending. Default order for `displayName` is ascending.
SortBy ListPrivilegedApiRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ListPrivilegedApiRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPrivilegedApiRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPrivilegedApiRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPrivilegedApiRequestsRequest) String() string
func (request ListPrivilegedApiRequestsRequest) 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
ListPrivilegedApiRequestsResponse wrapper for the ListPrivilegedApiRequests operation
type ListPrivilegedApiRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of PrivilegedApiRequestCollection instances
PrivilegedApiRequestCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListPrivilegedApiRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPrivilegedApiRequestsResponse) String() string
ListPrivilegedApiRequestsSortByEnum Enum with underlying type: string
type ListPrivilegedApiRequestsSortByEnum string
Set of constants representing the allowable values for ListPrivilegedApiRequestsSortByEnum
const (
ListPrivilegedApiRequestsSortByTimecreated ListPrivilegedApiRequestsSortByEnum = "timeCreated"
ListPrivilegedApiRequestsSortByDisplayname ListPrivilegedApiRequestsSortByEnum = "displayName"
)
func GetListPrivilegedApiRequestsSortByEnumValues() []ListPrivilegedApiRequestsSortByEnum
GetListPrivilegedApiRequestsSortByEnumValues Enumerates the set of values for ListPrivilegedApiRequestsSortByEnum
func GetMappingListPrivilegedApiRequestsSortByEnum(val string) (ListPrivilegedApiRequestsSortByEnum, bool)
GetMappingListPrivilegedApiRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPrivilegedApiRequestsSortOrderEnum Enum with underlying type: string
type ListPrivilegedApiRequestsSortOrderEnum string
Set of constants representing the allowable values for ListPrivilegedApiRequestsSortOrderEnum
const (
ListPrivilegedApiRequestsSortOrderAsc ListPrivilegedApiRequestsSortOrderEnum = "ASC"
ListPrivilegedApiRequestsSortOrderDesc ListPrivilegedApiRequestsSortOrderEnum = "DESC"
)
func GetListPrivilegedApiRequestsSortOrderEnumValues() []ListPrivilegedApiRequestsSortOrderEnum
GetListPrivilegedApiRequestsSortOrderEnumValues Enumerates the set of values for ListPrivilegedApiRequestsSortOrderEnum
func GetMappingListPrivilegedApiRequestsSortOrderEnum(val string) (ListPrivilegedApiRequestsSortOrderEnum, bool)
GetMappingListPrivilegedApiRequestsSortOrderEnum 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/apiaccesscontrol/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`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 list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
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 (
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)
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/apiaccesscontrol/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`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 list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
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 (
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)
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/apiaccesscontrol/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only the resources that match the given lifecycle state.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either ascending (`ASC`) or descending (`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 list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
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"
ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
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
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"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
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 (
OperationTypeCreatePrivilegedApiControl OperationTypeEnum = "CREATE_PRIVILEGED_API_CONTROL"
OperationTypeGetPrivilegedApiControl OperationTypeEnum = "GET_PRIVILEGED_API_CONTROL"
OperationTypeListPrivilegedApiControl OperationTypeEnum = "LIST_PRIVILEGED_API_CONTROL"
OperationTypeUpdatePrivilegedApiControl OperationTypeEnum = "UPDATE_PRIVILEGED_API_CONTROL"
OperationTypeDeletePrivilegedApiControl OperationTypeEnum = "DELETE_PRIVILEGED_API_CONTROL"
OperationTypeMovePrivilegedApiControl OperationTypeEnum = "MOVE_PRIVILEGED_API_CONTROL"
OperationTypeCreatePrivilegedApiRequest OperationTypeEnum = "CREATE_PRIVILEGED_API_REQUEST"
OperationTypeGetPrivilegedApiRequest OperationTypeEnum = "GET_PRIVILEGED_API_REQUEST"
OperationTypeListPrivilegedApiRequest OperationTypeEnum = "LIST_PRIVILEGED_API_REQUEST"
OperationTypeApprovePrivilegedApiRequest OperationTypeEnum = "APPROVE_PRIVILEGED_API_REQUEST"
OperationTypeRejectPrivilegedApiRequest OperationTypeEnum = "REJECT_PRIVILEGED_API_REQUEST"
OperationTypeRevokePrivilegedApiRequest OperationTypeEnum = "REVOKE_PRIVILEGED_API_REQUEST"
OperationTypeClosePrivilegedApiRequest OperationTypeEnum = "CLOSE_PRIVILEGED_API_REQUEST"
OperationTypeTimeoutPrivilegedApiRequest OperationTypeEnum = "TIMEOUT_PRIVILEGED_API_REQUEST"
OperationTypeCustomerApprovalCheckPrivilegedApiRequest OperationTypeEnum = "CUSTOMER_APPROVAL_CHECK_PRIVILEGED_API_REQUEST"
OperationTypeCheckPrivilegedApiRequestStatus OperationTypeEnum = "CHECK_PRIVILEGED_API_REQUEST_STATUS"
OperationTypeGetPrivilegedApiWorkRequest OperationTypeEnum = "GET_PRIVILEGED_API_WORK_REQUEST"
OperationTypeListPrivilegedApiWorkRequest OperationTypeEnum = "LIST_PRIVILEGED_API_WORK_REQUEST"
OperationTypeListPrivilegedApiWorkRequestErrors OperationTypeEnum = "LIST_PRIVILEGED_API_WORK_REQUEST_ERRORS"
OperationTypeListPrivilegedApiWorkRequestLogs OperationTypeEnum = "LIST_PRIVILEGED_API_WORK_REQUEST_LOGS"
OperationTypeCancelPrivilegedApiWorkRequest OperationTypeEnum = "CANCEL_PRIVILEGED_API_WORK_REQUEST"
OperationTypeListApiMetadata OperationTypeEnum = "LIST_API_METADATA"
OperationTypeListApiMetadataByEntityType OperationTypeEnum = "LIST_API_METADATA_BY_ENTITY_TYPE"
)
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
PrivilegedApiControl A PrivilegedApiControl is a kind of Policy definition which provides details about which operations needs to be secure; who can approve a privilegedApiRequest requesting for a particular operation, whether the operations needs to be approved by customer or is it preApproved. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type PrivilegedApiControl struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivilegedApiControl.
Id *string `mandatory:"true" json:"id"`
// Name of the privilegedApi control. The name must be unique.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the PrivilegedApiControl.
State *string `mandatory:"true" json:"state"`
// The current state of the PrivilegedApiControl.
LifecycleState PrivilegedApiControlLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// Description of privilegedApi control.
Description *string `mandatory:"false" json:"description"`
// The OCID of the OCI Notification topic to publish messages related to this Privileged Api Control.
NotificationTopicId *string `mandatory:"false" json:"notificationTopicId"`
// List of IAM user group ids who can approve an privilegedApi request associated with a target resource under the governance of this operator control.
ApproverGroupIdList []string `mandatory:"false" json:"approverGroupIdList"`
// resourceType for which the PrivilegedApiControl is applicable
ResourceType *string `mandatory:"false" json:"resourceType"`
// contains Resource details
Resources []string `mandatory:"false" json:"resources"`
// List of privileged operations/apis. These operations/apis will be treaated as secured, once enabled by the Privileged API Managment for a resource. Any of these operations, if needs to be executed, needs to be raised as a PrivilegedApi Request which needs to be approved by customers or it can be pre-approved.
PrivilegedOperationList []PrivilegedApiDetails `mandatory:"false" json:"privilegedOperationList"`
// Number of approvers required to approve an privilegedApi request.
NumberOfApprovers *int `mandatory:"false" json:"numberOfApprovers"`
// The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeDeleted *common.SDKTime `mandatory:"false" json:"timeDeleted"`
// A message that describes the current state of the PrivilegedApiControl in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
StateDetails *string `mandatory:"false" json:"stateDetails"`
// A message that describes the current state of the PrivilegedApiControl in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m PrivilegedApiControl) String() string
func (m PrivilegedApiControl) 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
PrivilegedApiControlClient a client for PrivilegedApiControl
type PrivilegedApiControlClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewPrivilegedApiControlClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client PrivilegedApiControlClient, err error)
NewPrivilegedApiControlClientWithConfigurationProvider Creates a new default PrivilegedApiControl client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewPrivilegedApiControlClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client PrivilegedApiControlClient, err error)
NewPrivilegedApiControlClientWithOboToken Creates a new default PrivilegedApiControl 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 PrivilegedApiControlClient) ChangePrivilegedApiControlCompartment(ctx context.Context, request ChangePrivilegedApiControlCompartmentRequest) (response ChangePrivilegedApiControlCompartmentResponse, err error)
ChangePrivilegedApiControlCompartment Moves a PrivilegedApiControl into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ChangePrivilegedApiControlCompartment.go.html to see an example of how to use ChangePrivilegedApiControlCompartment API. A default retry strategy applies to this operation ChangePrivilegedApiControlCompartment()
func (client *PrivilegedApiControlClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client PrivilegedApiControlClient) CreatePrivilegedApiControl(ctx context.Context, request CreatePrivilegedApiControlRequest) (response CreatePrivilegedApiControlResponse, err error)
CreatePrivilegedApiControl Creates a PrivilegedApiControl.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/CreatePrivilegedApiControl.go.html to see an example of how to use CreatePrivilegedApiControl API. A default retry strategy applies to this operation CreatePrivilegedApiControl()
func (client PrivilegedApiControlClient) DeletePrivilegedApiControl(ctx context.Context, request DeletePrivilegedApiControlRequest) (response DeletePrivilegedApiControlResponse, err error)
DeletePrivilegedApiControl Deletes a PrivilegedApiControl.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/DeletePrivilegedApiControl.go.html to see an example of how to use DeletePrivilegedApiControl API. A default retry strategy applies to this operation DeletePrivilegedApiControl()
func (client PrivilegedApiControlClient) GetPrivilegedApiControl(ctx context.Context, request GetPrivilegedApiControlRequest) (response GetPrivilegedApiControlResponse, err error)
GetPrivilegedApiControl Gets information about a PrivilegedApiControl.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/GetPrivilegedApiControl.go.html to see an example of how to use GetPrivilegedApiControl API. A default retry strategy applies to this operation GetPrivilegedApiControl()
func (client PrivilegedApiControlClient) ListPrivilegedApiControls(ctx context.Context, request ListPrivilegedApiControlsRequest) (response ListPrivilegedApiControlsResponse, err error)
ListPrivilegedApiControls Gets a list of PrivilegedApiControls.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ListPrivilegedApiControls.go.html to see an example of how to use ListPrivilegedApiControls API. A default retry strategy applies to this operation ListPrivilegedApiControls()
func (client *PrivilegedApiControlClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client PrivilegedApiControlClient) UpdatePrivilegedApiControl(ctx context.Context, request UpdatePrivilegedApiControlRequest) (response UpdatePrivilegedApiControlResponse, err error)
UpdatePrivilegedApiControl Updates a PrivilegedApiControl.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/UpdatePrivilegedApiControl.go.html to see an example of how to use UpdatePrivilegedApiControl API. A default retry strategy applies to this operation UpdatePrivilegedApiControl()
PrivilegedApiControlCollection Results of a privilegedApiControl search. Contains both PrivilegedApiControlSummary items and other information, such as metadata.
type PrivilegedApiControlCollection struct {
// List of privilegedApiControls.
Items []PrivilegedApiControlSummary `mandatory:"true" json:"items"`
}
func (m PrivilegedApiControlCollection) String() string
func (m PrivilegedApiControlCollection) 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
PrivilegedApiControlLifecycleStateEnum Enum with underlying type: string
type PrivilegedApiControlLifecycleStateEnum string
Set of constants representing the allowable values for PrivilegedApiControlLifecycleStateEnum
const (
PrivilegedApiControlLifecycleStateCreating PrivilegedApiControlLifecycleStateEnum = "CREATING"
PrivilegedApiControlLifecycleStateUpdating PrivilegedApiControlLifecycleStateEnum = "UPDATING"
PrivilegedApiControlLifecycleStateActive PrivilegedApiControlLifecycleStateEnum = "ACTIVE"
PrivilegedApiControlLifecycleStateDeleting PrivilegedApiControlLifecycleStateEnum = "DELETING"
PrivilegedApiControlLifecycleStateDeleted PrivilegedApiControlLifecycleStateEnum = "DELETED"
PrivilegedApiControlLifecycleStateFailed PrivilegedApiControlLifecycleStateEnum = "FAILED"
PrivilegedApiControlLifecycleStateNeedsAttention PrivilegedApiControlLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetMappingPrivilegedApiControlLifecycleStateEnum(val string) (PrivilegedApiControlLifecycleStateEnum, bool)
GetMappingPrivilegedApiControlLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPrivilegedApiControlLifecycleStateEnumValues() []PrivilegedApiControlLifecycleStateEnum
GetPrivilegedApiControlLifecycleStateEnumValues Enumerates the set of values for PrivilegedApiControlLifecycleStateEnum
PrivilegedApiControlSummary Summary information about a PrivilegedApiControl.
type PrivilegedApiControlSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivilegedApiControl.
Id *string `mandatory:"true" json:"id"`
// Name of the privilegedApi control.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the PrivilegedApiControl.
LifecycleState PrivilegedApiControlLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// resourceType for which the PrivilegedApiControl is applicable
ResourceType *string `mandatory:"false" json:"resourceType"`
// Number of approvers required to approve an privilegedApi request.
NumberOfApprovers *int `mandatory:"false" json:"numberOfApprovers"`
// The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Time when the privilegedApi control was deleted, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: '2020-05-22T21:10:29.600Z'
TimeDeleted *common.SDKTime `mandatory:"false" json:"timeDeleted"`
// A message that describes the current state of the PrivilegedApiControl in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m PrivilegedApiControlSummary) String() string
func (m PrivilegedApiControlSummary) 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
PrivilegedApiDetails It represents the api details of the service
type PrivilegedApiDetails struct {
// name of the api which needs to be protected.
ApiName *string `mandatory:"true" json:"apiName"`
// type of the entity which needs to be protected.
EntityType *string `mandatory:"false" json:"entityType"`
// list of attributes belonging to the above api which needs to be protected.
AttributeNames []string `mandatory:"false" json:"attributeNames"`
}
func (m PrivilegedApiDetails) String() string
func (m PrivilegedApiDetails) 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
PrivilegedApiRequest An Oracle operator raises privilegedApi request when they need access to any infrastructure resource governed by PrivilegedApi Access Control.
The privilegedApi request identifies the target resource and the set of operator actions. Access request handling depends upon the Operator Control that governs the target resource, and the set of operator actions listed for approval in the access request. If all of the operator actions listed in the privilegedApi request are in the pre-approved list in the PrivilegedApi Control that governs the target resource, then the privilegedApi request is automatically approved. If not, then the privilegedApi request requires explicit approval from the approver group specified by the PrivilegedApi Control governing the target resource.
You can approve or reject an privilegedApi request. You can also revoke the approval of an already approved privilegedApi request. While creating an access request,
the operator specifies the duration of access. You have the option to approve the entire duration or reduce or even increase the time duration. An operator can also request for an extension. The approval for such an extension is processed the same way the original privilegedApi request was processed.
type PrivilegedApiRequest struct {
// The OCID of the privilegedApi request.
Id *string `mandatory:"true" json:"id"`
// Summary comment by the operator creating the access request.
ReasonSummary *string `mandatory:"true" json:"reasonSummary"`
// The OCID of the target resource associated with the access request. The operator raises an access request to get approval to access the target resource.
ResourceId *string `mandatory:"true" json:"resourceId"`
// The current state of the Access Request.
State PrivilegedApiRequestStateEnum `mandatory:"true" json:"state"`
// Name of the privilegedApi control. The name must be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// This is an automatic identifier generated by the system which is easier for human comprehension.
RequestId *string `mandatory:"false" json:"requestId"`
// The OCID of the OCI Notification topic to publish messages related to this privileged api request.
NotificationTopicId *string `mandatory:"false" json:"notificationTopicId"`
// List of Users who has created this privilegedApiRequest.
RequestedBy []string `mandatory:"false" json:"requestedBy"`
// resourceName for which the PrivilegedApiRequest is applicable
ResourceName *string `mandatory:"false" json:"resourceName"`
// The subresource names requested for approval.
SubResourceNameList []string `mandatory:"false" json:"subResourceNameList"`
// The OCID of the compartment that contains the access request.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// resourceType for which the AccessRequest is applicable
ResourceType *string `mandatory:"false" json:"resourceType"`
// entityType of resource for which the AccessRequest is applicable
EntityType *string `mandatory:"false" json:"entityType"`
// List of api names, attributes for which approval is sought by the user.
PrivilegedOperationList []PrivilegedApiRequestOperationDetails `mandatory:"false" json:"privilegedOperationList"`
// Reason in Detail for which the operator is requesting access on the target resource.
ReasonDetail *string `mandatory:"false" json:"reasonDetail"`
// Priority assigned to the access request by the operator
Severity PrivilegedApiRequestSeverityEnum `mandatory:"false" json:"severity,omitempty"`
// Duration in hours for which access is sought on the target resource.
DurationInHrs *int `mandatory:"false" json:"durationInHrs"`
// A list of ticket numbers related to this Privileged Api Access Request, e.g. Service Request (SR) number and JIRA ticket number.
TicketNumbers []string `mandatory:"false" json:"ticketNumbers"`
// A message that describes the current state of the PrivilegedApiControl in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
StateDetails *string `mandatory:"false" json:"stateDetails"`
// The current state of the PrivilegedApiRequest.
LifecycleState PrivilegedApiRequestLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// more in detail about the lifeCycleState.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Time when the privilegedApi request was created in RFC 3339 (https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z'
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Time when the privilegedApi request was last modified in RFC 3339 (https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z'
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The comment entered by the operator while closing the request.
ClosureComment *string `mandatory:"false" json:"closureComment"`
// The OCID of the privilegedApi control governing the target resource.
PrivilegedApiControlId *string `mandatory:"false" json:"privilegedApiControlId"`
// Name of the privilegedApi control governing the target resource.
PrivilegedApiControlName *string `mandatory:"false" json:"privilegedApiControlName"`
// Number of approvers required to approve an privilegedApi request.
NumberOfApproversRequired *int `mandatory:"false" json:"numberOfApproversRequired"`
// Contains the approver details who have approved the privilegedApi Request during the initial request.
ApproverDetails []ApproverDetail `mandatory:"false" json:"approverDetails"`
// Time in future when the user for the privilegedApi request needs to be created in RFC 3339 (https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z'
TimeRequestedForFutureAccess *common.SDKTime `mandatory:"false" json:"timeRequestedForFutureAccess"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m PrivilegedApiRequest) String() string
func (m PrivilegedApiRequest) 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
PrivilegedApiRequestCollection Results of privilegedApi request search, which contains summary of privilegedApi request.
type PrivilegedApiRequestCollection struct {
// contains PrivilegedApiRequestSummary
Items []PrivilegedApiRequestSummary `mandatory:"true" json:"items"`
}
func (m PrivilegedApiRequestCollection) String() string
func (m PrivilegedApiRequestCollection) 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
PrivilegedApiRequestLifecycleStateEnum Enum with underlying type: string
type PrivilegedApiRequestLifecycleStateEnum string
Set of constants representing the allowable values for PrivilegedApiRequestLifecycleStateEnum
const (
PrivilegedApiRequestLifecycleStateAccepted PrivilegedApiRequestLifecycleStateEnum = "ACCEPTED"
PrivilegedApiRequestLifecycleStateInProgress PrivilegedApiRequestLifecycleStateEnum = "IN_PROGRESS"
PrivilegedApiRequestLifecycleStateWaiting PrivilegedApiRequestLifecycleStateEnum = "WAITING"
PrivilegedApiRequestLifecycleStateFailed PrivilegedApiRequestLifecycleStateEnum = "FAILED"
PrivilegedApiRequestLifecycleStateSucceeded PrivilegedApiRequestLifecycleStateEnum = "SUCCEEDED"
PrivilegedApiRequestLifecycleStateCanceling PrivilegedApiRequestLifecycleStateEnum = "CANCELING"
PrivilegedApiRequestLifecycleStateCanceled PrivilegedApiRequestLifecycleStateEnum = "CANCELED"
PrivilegedApiRequestLifecycleStateNeedsAttention PrivilegedApiRequestLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetMappingPrivilegedApiRequestLifecycleStateEnum(val string) (PrivilegedApiRequestLifecycleStateEnum, bool)
GetMappingPrivilegedApiRequestLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPrivilegedApiRequestLifecycleStateEnumValues() []PrivilegedApiRequestLifecycleStateEnum
GetPrivilegedApiRequestLifecycleStateEnumValues Enumerates the set of values for PrivilegedApiRequestLifecycleStateEnum
PrivilegedApiRequestOperationDetails It represents the api details of the service
type PrivilegedApiRequestOperationDetails struct {
// name of the api which needs to be protected.
ApiName *string `mandatory:"true" json:"apiName"`
// list of attributes belonging to the above api which needs to be protected.
AttributeNames []string `mandatory:"false" json:"attributeNames"`
}
func (m PrivilegedApiRequestOperationDetails) String() string
func (m PrivilegedApiRequestOperationDetails) 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
PrivilegedApiRequestSeverityEnum Enum with underlying type: string
type PrivilegedApiRequestSeverityEnum string
Set of constants representing the allowable values for PrivilegedApiRequestSeverityEnum
const (
PrivilegedApiRequestSeveritySev1 PrivilegedApiRequestSeverityEnum = "SEV_1"
PrivilegedApiRequestSeveritySev2 PrivilegedApiRequestSeverityEnum = "SEV_2"
PrivilegedApiRequestSeveritySev3 PrivilegedApiRequestSeverityEnum = "SEV_3"
PrivilegedApiRequestSeveritySev4 PrivilegedApiRequestSeverityEnum = "SEV_4"
)
func GetMappingPrivilegedApiRequestSeverityEnum(val string) (PrivilegedApiRequestSeverityEnum, bool)
GetMappingPrivilegedApiRequestSeverityEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPrivilegedApiRequestSeverityEnumValues() []PrivilegedApiRequestSeverityEnum
GetPrivilegedApiRequestSeverityEnumValues Enumerates the set of values for PrivilegedApiRequestSeverityEnum
PrivilegedApiRequestStateEnum Enum with underlying type: string
type PrivilegedApiRequestStateEnum string
Set of constants representing the allowable values for PrivilegedApiRequestStateEnum
const (
PrivilegedApiRequestStateCreated PrivilegedApiRequestStateEnum = "CREATED"
PrivilegedApiRequestStateApprovalWaiting PrivilegedApiRequestStateEnum = "APPROVAL_WAITING"
PrivilegedApiRequestStateApproved PrivilegedApiRequestStateEnum = "APPROVED"
PrivilegedApiRequestStateApprovedForFuture PrivilegedApiRequestStateEnum = "APPROVED_FOR_FUTURE"
PrivilegedApiRequestStateRejected PrivilegedApiRequestStateEnum = "REJECTED"
PrivilegedApiRequestStateDeployed PrivilegedApiRequestStateEnum = "DEPLOYED"
PrivilegedApiRequestStateDeployFailed PrivilegedApiRequestStateEnum = "DEPLOY_FAILED"
PrivilegedApiRequestStateCloseFailed PrivilegedApiRequestStateEnum = "CLOSE_FAILED"
PrivilegedApiRequestStateRevokeFailed PrivilegedApiRequestStateEnum = "REVOKE_FAILED"
PrivilegedApiRequestStateExpiryFailed PrivilegedApiRequestStateEnum = "EXPIRY_FAILED"
PrivilegedApiRequestStateRevoking PrivilegedApiRequestStateEnum = "REVOKING"
PrivilegedApiRequestStateRevoked PrivilegedApiRequestStateEnum = "REVOKED"
PrivilegedApiRequestStateClosing PrivilegedApiRequestStateEnum = "CLOSING"
PrivilegedApiRequestStateClosed PrivilegedApiRequestStateEnum = "CLOSED"
PrivilegedApiRequestStateExpired PrivilegedApiRequestStateEnum = "EXPIRED"
)
func GetMappingPrivilegedApiRequestStateEnum(val string) (PrivilegedApiRequestStateEnum, bool)
GetMappingPrivilegedApiRequestStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPrivilegedApiRequestStateEnumValues() []PrivilegedApiRequestStateEnum
GetPrivilegedApiRequestStateEnumValues Enumerates the set of values for PrivilegedApiRequestStateEnum
PrivilegedApiRequestSummary Summary of access request.
type PrivilegedApiRequestSummary struct {
// The OCID of the access request.
Id *string `mandatory:"true" json:"id"`
// Comment associated with the privilegedApi request.
ReasonSummary *string `mandatory:"true" json:"reasonSummary"`
// The OCID of the target resource associated with the privilegedApi request. The operator raises an privilegedApi request to get approval to access the target resource.
ResourceId *string `mandatory:"true" json:"resourceId"`
// Name of the privilegedApi control. The name must be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// This is a system-generated identifier to identity a Request in human readable form in the form of REQYYYYMMDD<number>.
RequestId *string `mandatory:"false" json:"requestId"`
// The OCID of the compartment that contains the privilegedApi request.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// resourceName for which the PrivilegedApiRequest is applicable
ResourceName *string `mandatory:"false" json:"resourceName"`
// The subresource names requested for approval.
SubResourceNameList []string `mandatory:"false" json:"subResourceNameList"`
// resourceType for which the PrivilegedApiRequest is applicable
ResourceType *string `mandatory:"false" json:"resourceType"`
// List of api names, attributes for which approval is sought by the user.
PrivilegedOperationList []PrivilegedApiRequestOperationDetails `mandatory:"false" json:"privilegedOperationList"`
// The current state of the Access Request.
State PrivilegedApiRequestStateEnum `mandatory:"false" json:"state,omitempty"`
// The current state of the PrivilegedApiRequest.
LifecycleState PrivilegedApiRequestLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// More in detail about the lifeCycleState.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Time when the privilegedApi request was created by the operator user in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z'
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Time when the privilegedApi request was last modified in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z'
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Duration in hours for which access is sought on the target resource.
DurationInHrs *int `mandatory:"false" json:"durationInHrs"`
// Priority assigned to the privilegedApi request by the operator
Severity PrivilegedApiRequestSeverityEnum `mandatory:"false" json:"severity,omitempty"`
// Time in future when the user for the access request needs to be created in RFC 3339 (https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z'
TimeRequestedForFutureAccess *common.SDKTime `mandatory:"false" json:"timeRequestedForFutureAccess"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m PrivilegedApiRequestSummary) String() string
func (m PrivilegedApiRequestSummary) 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
PrivilegedApiRequestsClient a client for PrivilegedApiRequests
type PrivilegedApiRequestsClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewPrivilegedApiRequestsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client PrivilegedApiRequestsClient, err error)
NewPrivilegedApiRequestsClientWithConfigurationProvider Creates a new default PrivilegedApiRequests client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewPrivilegedApiRequestsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client PrivilegedApiRequestsClient, err error)
NewPrivilegedApiRequestsClientWithOboToken Creates a new default PrivilegedApiRequests 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 PrivilegedApiRequestsClient) ApprovePrivilegedApiRequest(ctx context.Context, request ApprovePrivilegedApiRequestRequest) (response ApprovePrivilegedApiRequestResponse, err error)
ApprovePrivilegedApiRequest Approves privilegedApi request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ApprovePrivilegedApiRequest.go.html to see an example of how to use ApprovePrivilegedApiRequest API. A default retry strategy applies to this operation ApprovePrivilegedApiRequest()
func (client PrivilegedApiRequestsClient) ClosePrivilegedApiRequest(ctx context.Context, request ClosePrivilegedApiRequestRequest) (response ClosePrivilegedApiRequestResponse, err error)
ClosePrivilegedApiRequest Closes privilegedApi request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ClosePrivilegedApiRequest.go.html to see an example of how to use ClosePrivilegedApiRequest API. A default retry strategy applies to this operation ClosePrivilegedApiRequest()
func (client *PrivilegedApiRequestsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client PrivilegedApiRequestsClient) CreatePrivilegedApiRequest(ctx context.Context, request CreatePrivilegedApiRequestRequest) (response CreatePrivilegedApiRequestResponse, err error)
CreatePrivilegedApiRequest Creates a PrivilegedApiRequest.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/CreatePrivilegedApiRequest.go.html to see an example of how to use CreatePrivilegedApiRequest API. A default retry strategy applies to this operation CreatePrivilegedApiRequest()
func (client PrivilegedApiRequestsClient) GetPrivilegedApiRequest(ctx context.Context, request GetPrivilegedApiRequestRequest) (response GetPrivilegedApiRequestResponse, err error)
GetPrivilegedApiRequest Gets information about a PrivilegedApiRequest.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/GetPrivilegedApiRequest.go.html to see an example of how to use GetPrivilegedApiRequest API. A default retry strategy applies to this operation GetPrivilegedApiRequest()
func (client PrivilegedApiRequestsClient) ListPrivilegedApiRequests(ctx context.Context, request ListPrivilegedApiRequestsRequest) (response ListPrivilegedApiRequestsResponse, err error)
ListPrivilegedApiRequests Lists all privilegedApi requests in the compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ListPrivilegedApiRequests.go.html to see an example of how to use ListPrivilegedApiRequests API. A default retry strategy applies to this operation ListPrivilegedApiRequests()
func (client PrivilegedApiRequestsClient) RejectPrivilegedApiRequest(ctx context.Context, request RejectPrivilegedApiRequestRequest) (response RejectPrivilegedApiRequestResponse, err error)
RejectPrivilegedApiRequest Rejects privilegedApi request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/RejectPrivilegedApiRequest.go.html to see an example of how to use RejectPrivilegedApiRequest API. A default retry strategy applies to this operation RejectPrivilegedApiRequest()
func (client PrivilegedApiRequestsClient) RevokePrivilegedApiRequest(ctx context.Context, request RevokePrivilegedApiRequestRequest) (response RevokePrivilegedApiRequestResponse, err error)
RevokePrivilegedApiRequest Revokes an already approved privilegedApi request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/RevokePrivilegedApiRequest.go.html to see an example of how to use RevokePrivilegedApiRequest API. A default retry strategy applies to this operation RevokePrivilegedApiRequest()
func (client *PrivilegedApiRequestsClient) SetRegion(region string)
SetRegion overrides the region of this client.
PrivilegedApiWorkRequestClient a client for PrivilegedApiWorkRequest
type PrivilegedApiWorkRequestClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewPrivilegedApiWorkRequestClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client PrivilegedApiWorkRequestClient, err error)
NewPrivilegedApiWorkRequestClientWithConfigurationProvider Creates a new default PrivilegedApiWorkRequest client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewPrivilegedApiWorkRequestClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client PrivilegedApiWorkRequestClient, err error)
NewPrivilegedApiWorkRequestClientWithOboToken Creates a new default PrivilegedApiWorkRequest 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 PrivilegedApiWorkRequestClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancels a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()
func (client *PrivilegedApiWorkRequestClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client PrivilegedApiWorkRequestClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the details of a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client PrivilegedApiWorkRequestClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists the errors for a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client PrivilegedApiWorkRequestClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs for a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client PrivilegedApiWorkRequestClient) 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/apiaccesscontrol/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *PrivilegedApiWorkRequestClient) SetRegion(region string)
SetRegion overrides the region of this client.
RejectPrivilegedApiRequestDetails Summary of why the privilegedApi request was rejected.
type RejectPrivilegedApiRequestDetails struct {
// Comment by the approver explaining why the request is rejected.
ApproverComment *string `mandatory:"false" json:"approverComment"`
}
func (m RejectPrivilegedApiRequestDetails) String() string
func (m RejectPrivilegedApiRequestDetails) 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
RejectPrivilegedApiRequestRequest wrapper for the RejectPrivilegedApiRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/RejectPrivilegedApiRequest.go.html to see an example of how to use RejectPrivilegedApiRequestRequest.
type RejectPrivilegedApiRequestRequest struct {
// unique PrivilegedApiRequest identifier
PrivilegedApiRequestId *string `mandatory:"true" contributesTo:"path" name:"privilegedApiRequestId"`
// Details regarding the rejection of privilegedApi request created by the operator.
RejectPrivilegedApiRequestDetails `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 running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 RejectPrivilegedApiRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RejectPrivilegedApiRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RejectPrivilegedApiRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RejectPrivilegedApiRequestRequest) String() string
func (request RejectPrivilegedApiRequestRequest) 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
RejectPrivilegedApiRequestResponse wrapper for the RejectPrivilegedApiRequest operation
type RejectPrivilegedApiRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 RejectPrivilegedApiRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RejectPrivilegedApiRequestResponse) String() string
RevokePrivilegedApiRequestDetails Summary of why the already approved privilegedApi request was revoked.
type RevokePrivilegedApiRequestDetails struct {
// Comment specified by the approver explaining why the approval is revoked.
ApproverComment *string `mandatory:"false" json:"approverComment"`
}
func (m RevokePrivilegedApiRequestDetails) String() string
func (m RevokePrivilegedApiRequestDetails) 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
RevokePrivilegedApiRequestRequest wrapper for the RevokePrivilegedApiRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/RevokePrivilegedApiRequest.go.html to see an example of how to use RevokePrivilegedApiRequestRequest.
type RevokePrivilegedApiRequestRequest struct {
// unique PrivilegedApiRequest identifier
PrivilegedApiRequestId *string `mandatory:"true" contributesTo:"path" name:"privilegedApiRequestId"`
// Details regarding the revocation of privilegedApi request created by the operator.
RevokePrivilegedApiRequestDetails `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 running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 RevokePrivilegedApiRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RevokePrivilegedApiRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RevokePrivilegedApiRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RevokePrivilegedApiRequestRequest) String() string
func (request RevokePrivilegedApiRequestRequest) 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
RevokePrivilegedApiRequestResponse wrapper for the RevokePrivilegedApiRequest operation
type RevokePrivilegedApiRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 RevokePrivilegedApiRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RevokePrivilegedApiRequestResponse) String() string
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
UpdatePrivilegedApiControlDetails The data to update a PrivilegedApiControl.
type UpdatePrivilegedApiControlDetails struct {
// Name of the privilegedApi control. Needs to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the privilegedApi control.
Description *string `mandatory:"false" json:"description"`
// resourceType for which the PrivilegedApiControl is applicable
ResourceType *string `mandatory:"false" json:"resourceType"`
// contains Resource details
Resources []string `mandatory:"false" json:"resources"`
// The OCID of the OCI Notification topic to publish messages related to this Delegation Control.
NotificationTopicId *string `mandatory:"false" json:"notificationTopicId"`
// List of user IAM group ids who can approve an privilegedApi request associated with a target resource under the governance of this privilegedApi control.
ApproverGroupIdList []string `mandatory:"false" json:"approverGroupIdList"`
// List of privileged operator operations. If Privileged API Managment is enabled for a resource it will be validated whether the operation done by the operator is a part of privileged operation.
PrivilegedOperationList []PrivilegedApiDetails `mandatory:"false" json:"privilegedOperationList"`
// Number of approvers required to approve an privilegedApi request.
NumberOfApprovers *int `mandatory:"false" json:"numberOfApprovers"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdatePrivilegedApiControlDetails) String() string
func (m UpdatePrivilegedApiControlDetails) 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
UpdatePrivilegedApiControlRequest wrapper for the UpdatePrivilegedApiControl operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apiaccesscontrol/UpdatePrivilegedApiControl.go.html to see an example of how to use UpdatePrivilegedApiControlRequest.
type UpdatePrivilegedApiControlRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivilegedApiControl.
PrivilegedApiControlId *string `mandatory:"true" contributesTo:"path" name:"privilegedApiControlId"`
// The information to be updated.
UpdatePrivilegedApiControlDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 UpdatePrivilegedApiControlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePrivilegedApiControlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePrivilegedApiControlRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePrivilegedApiControlRequest) String() string
func (request UpdatePrivilegedApiControlRequest) 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
UpdatePrivilegedApiControlResponse wrapper for the UpdatePrivilegedApiControl operation
type UpdatePrivilegedApiControlResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 UpdatePrivilegedApiControlResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePrivilegedApiControlResponse) String() string
WorkRequest An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.
type WorkRequest struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
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 performing an operation that is tracked by a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. For a list of error codes, see
// API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// A human-readable error message.
Message *string `mandatory:"true" json:"message"`
// The date and time the error occurred, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
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 A list of work request errors. Can contain both errors and other information, such as metadata.
type WorkRequestErrorCollection struct {
// A list of work request errors.
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 performing an operation that is tracked by a work request.
type WorkRequestLogEntry struct {
// A human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The date and time the log message was written, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
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 A list of work request logs. Can contain both logs and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// A list of work request log entries.
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 that the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the operation tracked in the work request.
// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
// work is complete for that resource, at which point it transitions to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that you can use for a GET request 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 Summary information about an asynchronous work request.
type WorkRequestSummary struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
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 A list of work requests. Can contain both work requests and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// A list of work requests.
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