apiaccesscontrol

package
v65.101.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2025 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetApiMetadataLifecycleStateEnumStringValues

func GetApiMetadataLifecycleStateEnumStringValues() []string

GetApiMetadataLifecycleStateEnumStringValues Enumerates the set of values in String for ApiMetadataLifecycleStateEnum

func GetListApiMetadataByEntityTypesSortByEnumStringValues

func GetListApiMetadataByEntityTypesSortByEnumStringValues() []string

GetListApiMetadataByEntityTypesSortByEnumStringValues Enumerates the set of values in String for ListApiMetadataByEntityTypesSortByEnum

func GetListApiMetadataByEntityTypesSortOrderEnumStringValues

func GetListApiMetadataByEntityTypesSortOrderEnumStringValues() []string

GetListApiMetadataByEntityTypesSortOrderEnumStringValues Enumerates the set of values in String for ListApiMetadataByEntityTypesSortOrderEnum

func GetListApiMetadataSortByEnumStringValues

func GetListApiMetadataSortByEnumStringValues() []string

GetListApiMetadataSortByEnumStringValues Enumerates the set of values in String for ListApiMetadataSortByEnum

func GetListApiMetadataSortOrderEnumStringValues

func GetListApiMetadataSortOrderEnumStringValues() []string

GetListApiMetadataSortOrderEnumStringValues Enumerates the set of values in String for ListApiMetadataSortOrderEnum

func GetListPrivilegedApiControlsSortByEnumStringValues

func GetListPrivilegedApiControlsSortByEnumStringValues() []string

GetListPrivilegedApiControlsSortByEnumStringValues Enumerates the set of values in String for ListPrivilegedApiControlsSortByEnum

func GetListPrivilegedApiControlsSortOrderEnumStringValues

func GetListPrivilegedApiControlsSortOrderEnumStringValues() []string

GetListPrivilegedApiControlsSortOrderEnumStringValues Enumerates the set of values in String for ListPrivilegedApiControlsSortOrderEnum

func GetListPrivilegedApiRequestsSortByEnumStringValues

func GetListPrivilegedApiRequestsSortByEnumStringValues() []string

GetListPrivilegedApiRequestsSortByEnumStringValues Enumerates the set of values in String for ListPrivilegedApiRequestsSortByEnum

func GetListPrivilegedApiRequestsSortOrderEnumStringValues

func GetListPrivilegedApiRequestsSortOrderEnumStringValues() []string

GetListPrivilegedApiRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListPrivilegedApiRequestsSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetPrivilegedApiControlLifecycleStateEnumStringValues

func GetPrivilegedApiControlLifecycleStateEnumStringValues() []string

GetPrivilegedApiControlLifecycleStateEnumStringValues Enumerates the set of values in String for PrivilegedApiControlLifecycleStateEnum

func GetPrivilegedApiRequestLifecycleStateEnumStringValues

func GetPrivilegedApiRequestLifecycleStateEnumStringValues() []string

GetPrivilegedApiRequestLifecycleStateEnumStringValues Enumerates the set of values in String for PrivilegedApiRequestLifecycleStateEnum

func GetPrivilegedApiRequestSeverityEnumStringValues

func GetPrivilegedApiRequestSeverityEnumStringValues() []string

GetPrivilegedApiRequestSeverityEnumStringValues Enumerates the set of values in String for PrivilegedApiRequestSeverityEnum

func GetPrivilegedApiRequestStateEnumStringValues

func GetPrivilegedApiRequestStateEnumStringValues() []string

GetPrivilegedApiRequestStateEnumStringValues Enumerates the set of values in String for PrivilegedApiRequestStateEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

Types

type ActionTypeEnum

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type ApiMetadata

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

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

func (ApiMetadata) String

func (m ApiMetadata) String() string

func (ApiMetadata) ValidateEnumValue

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

type ApiMetadataByEntityTypeCollection

type ApiMetadataByEntityTypeCollection struct {

	// List of apiMetadataByEntityTypeSummary.
	Items []ApiMetadataByEntityTypeSummary `mandatory:"true" json:"items"`
}

ApiMetadataByEntityTypeCollection Results of a api search.

func (ApiMetadataByEntityTypeCollection) String

func (ApiMetadataByEntityTypeCollection) ValidateEnumValue

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

type ApiMetadataByEntityTypeSummary

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

ApiMetadataByEntityTypeSummary Summary information about a ApiMetadata.

func (ApiMetadataByEntityTypeSummary) String

func (ApiMetadataByEntityTypeSummary) ValidateEnumValue

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

type ApiMetadataClient

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

ApiMetadataClient a client for ApiMetadata

func NewApiMetadataClientWithConfigurationProvider

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

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 (*ApiMetadataClient) ConfigurationProvider

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

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

func (ApiMetadataClient) GetApiMetadata

func (client ApiMetadataClient) GetApiMetadata(ctx context.Context, request GetApiMetadataRequest) (response GetApiMetadataResponse, err error)

GetApiMetadata Gets information about a ApiMetadata.

See also

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 (ApiMetadataClient) ListApiMetadata

func (client ApiMetadataClient) ListApiMetadata(ctx context.Context, request ListApiMetadataRequest) (response ListApiMetadataResponse, err error)

ListApiMetadata Gets a list of ApiMetadata.

See also

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 (ApiMetadataClient) ListApiMetadataByEntityTypes

func (client ApiMetadataClient) ListApiMetadataByEntityTypes(ctx context.Context, request ListApiMetadataByEntityTypesRequest) (response ListApiMetadataByEntityTypesResponse, err error)

ListApiMetadataByEntityTypes Gets a list of ApiMetadata Grouped By Entity Types.

See also

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 (*ApiMetadataClient) SetRegion

func (client *ApiMetadataClient) SetRegion(region string)

SetRegion overrides the region of this client.

type ApiMetadataCollection

type ApiMetadataCollection struct {

	// List of apiMetadataSummary.
	Items []ApiMetadataSummary `mandatory:"true" json:"items"`
}

ApiMetadataCollection Results of a api search.

func (ApiMetadataCollection) String

func (m ApiMetadataCollection) String() string

func (ApiMetadataCollection) ValidateEnumValue

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

type ApiMetadataLifecycleStateEnum

type ApiMetadataLifecycleStateEnum string

ApiMetadataLifecycleStateEnum Enum with underlying type: string

const (
	ApiMetadataLifecycleStateCreating ApiMetadataLifecycleStateEnum = "CREATING"
	ApiMetadataLifecycleStateUpdating ApiMetadataLifecycleStateEnum = "UPDATING"
	ApiMetadataLifecycleStateActive   ApiMetadataLifecycleStateEnum = "ACTIVE"
	ApiMetadataLifecycleStateDeleting ApiMetadataLifecycleStateEnum = "DELETING"
	ApiMetadataLifecycleStateDeleted  ApiMetadataLifecycleStateEnum = "DELETED"
	ApiMetadataLifecycleStateFailed   ApiMetadataLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ApiMetadataLifecycleStateEnum

func GetApiMetadataLifecycleStateEnumValues

func GetApiMetadataLifecycleStateEnumValues() []ApiMetadataLifecycleStateEnum

GetApiMetadataLifecycleStateEnumValues Enumerates the set of values for ApiMetadataLifecycleStateEnum

func GetMappingApiMetadataLifecycleStateEnum

func GetMappingApiMetadataLifecycleStateEnum(val string) (ApiMetadataLifecycleStateEnum, bool)

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

type ApiMetadataSummary

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

ApiMetadataSummary Summary information about a ApiMetadata.

func (ApiMetadataSummary) String

func (m ApiMetadataSummary) String() string

func (ApiMetadataSummary) ValidateEnumValue

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

type ApprovePrivilegedApiRequestDetails

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

ApprovePrivilegedApiRequestDetails Details of the privilegedApi request approval such as when the approver approved and any comment provided by the approver.

func (ApprovePrivilegedApiRequestDetails) String

func (ApprovePrivilegedApiRequestDetails) ValidateEnumValue

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

type 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
}

ApprovePrivilegedApiRequestRequest wrapper for the ApprovePrivilegedApiRequest operation

See also

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.

func (ApprovePrivilegedApiRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ApprovePrivilegedApiRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ApprovePrivilegedApiRequestRequest) RetryPolicy

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

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

func (ApprovePrivilegedApiRequestRequest) String

func (request ApprovePrivilegedApiRequestRequest) String() string

func (ApprovePrivilegedApiRequestRequest) ValidateEnumValue

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

type ApprovePrivilegedApiRequestResponse

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

ApprovePrivilegedApiRequestResponse wrapper for the ApprovePrivilegedApiRequest operation

func (ApprovePrivilegedApiRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ApprovePrivilegedApiRequestResponse) String

func (response ApprovePrivilegedApiRequestResponse) String() string

type ApproverDetail

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

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.

func (ApproverDetail) String

func (m ApproverDetail) String() string

func (ApproverDetail) ValidateEnumValue

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

type 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
}

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

See also

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.

func (CancelWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CancelWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy

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

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

func (CancelWorkRequestRequest) String

func (request CancelWorkRequestRequest) String() string

func (CancelWorkRequestRequest) ValidateEnumValue

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

type CancelWorkRequestResponse

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

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

func (CancelWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String

func (response CancelWorkRequestResponse) String() string

type ChangePrivilegedApiControlCompartmentDetails

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

ChangePrivilegedApiControlCompartmentDetails The configuration details for the move operation.

func (ChangePrivilegedApiControlCompartmentDetails) String

func (ChangePrivilegedApiControlCompartmentDetails) ValidateEnumValue

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

type 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
}

ChangePrivilegedApiControlCompartmentRequest wrapper for the ChangePrivilegedApiControlCompartment operation

See also

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.

func (ChangePrivilegedApiControlCompartmentRequest) BinaryRequestBody

BinaryRequestBody implements the OCIRequest interface

func (ChangePrivilegedApiControlCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangePrivilegedApiControlCompartmentRequest) RetryPolicy

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

func (ChangePrivilegedApiControlCompartmentRequest) String

func (ChangePrivilegedApiControlCompartmentRequest) ValidateEnumValue

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

type ChangePrivilegedApiControlCompartmentResponse

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

ChangePrivilegedApiControlCompartmentResponse wrapper for the ChangePrivilegedApiControlCompartment operation

func (ChangePrivilegedApiControlCompartmentResponse) HTTPResponse

HTTPResponse implements the OCIResponse interface

func (ChangePrivilegedApiControlCompartmentResponse) String

type ClosePrivilegedApiRequestDetails

type ClosePrivilegedApiRequestDetails struct {

	// description about why the request is closed
	Description *string `mandatory:"false" json:"description"`
}

ClosePrivilegedApiRequestDetails The information about closing PrivilegedApiRequest.

func (ClosePrivilegedApiRequestDetails) String

func (ClosePrivilegedApiRequestDetails) ValidateEnumValue

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

type 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
}

ClosePrivilegedApiRequestRequest wrapper for the ClosePrivilegedApiRequest operation

See also

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.

func (ClosePrivilegedApiRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ClosePrivilegedApiRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ClosePrivilegedApiRequestRequest) RetryPolicy

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

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

func (ClosePrivilegedApiRequestRequest) String

func (request ClosePrivilegedApiRequestRequest) String() string

func (ClosePrivilegedApiRequestRequest) ValidateEnumValue

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

type ClosePrivilegedApiRequestResponse

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

ClosePrivilegedApiRequestResponse wrapper for the ClosePrivilegedApiRequest operation

func (ClosePrivilegedApiRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ClosePrivilegedApiRequestResponse) String

func (response ClosePrivilegedApiRequestResponse) String() string

type CreatePrivilegedApiControlDetails

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

CreatePrivilegedApiControlDetails The data to create a PrivilegedApiControl.

func (CreatePrivilegedApiControlDetails) String

func (CreatePrivilegedApiControlDetails) ValidateEnumValue

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

type 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
}

CreatePrivilegedApiControlRequest wrapper for the CreatePrivilegedApiControl operation

See also

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.

func (CreatePrivilegedApiControlRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreatePrivilegedApiControlRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreatePrivilegedApiControlRequest) RetryPolicy

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

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

func (CreatePrivilegedApiControlRequest) String

func (request CreatePrivilegedApiControlRequest) String() string

func (CreatePrivilegedApiControlRequest) ValidateEnumValue

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

type CreatePrivilegedApiControlResponse

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

CreatePrivilegedApiControlResponse wrapper for the CreatePrivilegedApiControl operation

func (CreatePrivilegedApiControlResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreatePrivilegedApiControlResponse) String

func (response CreatePrivilegedApiControlResponse) String() string

type CreatePrivilegedApiRequestDetails

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

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.

func (CreatePrivilegedApiRequestDetails) String

func (CreatePrivilegedApiRequestDetails) ValidateEnumValue

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

type 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
}

CreatePrivilegedApiRequestRequest wrapper for the CreatePrivilegedApiRequest operation

See also

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.

func (CreatePrivilegedApiRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreatePrivilegedApiRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreatePrivilegedApiRequestRequest) RetryPolicy

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

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

func (CreatePrivilegedApiRequestRequest) String

func (request CreatePrivilegedApiRequestRequest) String() string

func (CreatePrivilegedApiRequestRequest) ValidateEnumValue

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

type CreatePrivilegedApiRequestResponse

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

CreatePrivilegedApiRequestResponse wrapper for the CreatePrivilegedApiRequest operation

func (CreatePrivilegedApiRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreatePrivilegedApiRequestResponse) String

func (response CreatePrivilegedApiRequestResponse) String() string

type 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
}

DeletePrivilegedApiControlRequest wrapper for the DeletePrivilegedApiControl operation

See also

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.

func (DeletePrivilegedApiControlRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeletePrivilegedApiControlRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeletePrivilegedApiControlRequest) RetryPolicy

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

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

func (DeletePrivilegedApiControlRequest) String

func (request DeletePrivilegedApiControlRequest) String() string

func (DeletePrivilegedApiControlRequest) ValidateEnumValue

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

type DeletePrivilegedApiControlResponse

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

DeletePrivilegedApiControlResponse wrapper for the DeletePrivilegedApiControl operation

func (DeletePrivilegedApiControlResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeletePrivilegedApiControlResponse) String

func (response DeletePrivilegedApiControlResponse) String() string

type 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
}

GetApiMetadataRequest wrapper for the GetApiMetadata operation

See also

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.

func (GetApiMetadataRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetApiMetadataRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetApiMetadataRequest) RetryPolicy

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

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

func (GetApiMetadataRequest) String

func (request GetApiMetadataRequest) String() string

func (GetApiMetadataRequest) ValidateEnumValue

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

type GetApiMetadataResponse

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

GetApiMetadataResponse wrapper for the GetApiMetadata operation

func (GetApiMetadataResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetApiMetadataResponse) String

func (response GetApiMetadataResponse) String() string

type 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
}

GetPrivilegedApiControlRequest wrapper for the GetPrivilegedApiControl operation

See also

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.

func (GetPrivilegedApiControlRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetPrivilegedApiControlRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetPrivilegedApiControlRequest) RetryPolicy

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

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

func (GetPrivilegedApiControlRequest) String

func (request GetPrivilegedApiControlRequest) String() string

func (GetPrivilegedApiControlRequest) ValidateEnumValue

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

type GetPrivilegedApiControlResponse

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

GetPrivilegedApiControlResponse wrapper for the GetPrivilegedApiControl operation

func (GetPrivilegedApiControlResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetPrivilegedApiControlResponse) String

func (response GetPrivilegedApiControlResponse) String() string

type 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
}

GetPrivilegedApiRequestRequest wrapper for the GetPrivilegedApiRequest operation

See also

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.

func (GetPrivilegedApiRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetPrivilegedApiRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetPrivilegedApiRequestRequest) RetryPolicy

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

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

func (GetPrivilegedApiRequestRequest) String

func (request GetPrivilegedApiRequestRequest) String() string

func (GetPrivilegedApiRequestRequest) ValidateEnumValue

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

type GetPrivilegedApiRequestResponse

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

GetPrivilegedApiRequestResponse wrapper for the GetPrivilegedApiRequest operation

func (GetPrivilegedApiRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetPrivilegedApiRequestResponse) String

func (response GetPrivilegedApiRequestResponse) String() string

type 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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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.

func (GetWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)

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

type GetWorkRequestResponse

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type 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
}

ListApiMetadataByEntityTypesRequest wrapper for the ListApiMetadataByEntityTypes operation

See also

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.

func (ListApiMetadataByEntityTypesRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListApiMetadataByEntityTypesRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListApiMetadataByEntityTypesRequest) RetryPolicy

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

func (ListApiMetadataByEntityTypesRequest) String

func (ListApiMetadataByEntityTypesRequest) ValidateEnumValue

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

type ListApiMetadataByEntityTypesResponse

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

ListApiMetadataByEntityTypesResponse wrapper for the ListApiMetadataByEntityTypes operation

func (ListApiMetadataByEntityTypesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListApiMetadataByEntityTypesResponse) String

func (response ListApiMetadataByEntityTypesResponse) String() string

type ListApiMetadataByEntityTypesSortByEnum

type ListApiMetadataByEntityTypesSortByEnum string

ListApiMetadataByEntityTypesSortByEnum Enum with underlying type: string

const (
	ListApiMetadataByEntityTypesSortByTimecreated ListApiMetadataByEntityTypesSortByEnum = "timeCreated"
	ListApiMetadataByEntityTypesSortByDisplayname ListApiMetadataByEntityTypesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListApiMetadataByEntityTypesSortByEnum

func GetListApiMetadataByEntityTypesSortByEnumValues

func GetListApiMetadataByEntityTypesSortByEnumValues() []ListApiMetadataByEntityTypesSortByEnum

GetListApiMetadataByEntityTypesSortByEnumValues Enumerates the set of values for ListApiMetadataByEntityTypesSortByEnum

func GetMappingListApiMetadataByEntityTypesSortByEnum

func GetMappingListApiMetadataByEntityTypesSortByEnum(val string) (ListApiMetadataByEntityTypesSortByEnum, bool)

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

type ListApiMetadataByEntityTypesSortOrderEnum

type ListApiMetadataByEntityTypesSortOrderEnum string

ListApiMetadataByEntityTypesSortOrderEnum Enum with underlying type: string

const (
	ListApiMetadataByEntityTypesSortOrderAsc  ListApiMetadataByEntityTypesSortOrderEnum = "ASC"
	ListApiMetadataByEntityTypesSortOrderDesc ListApiMetadataByEntityTypesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListApiMetadataByEntityTypesSortOrderEnum

func GetListApiMetadataByEntityTypesSortOrderEnumValues

func GetListApiMetadataByEntityTypesSortOrderEnumValues() []ListApiMetadataByEntityTypesSortOrderEnum

GetListApiMetadataByEntityTypesSortOrderEnumValues Enumerates the set of values for ListApiMetadataByEntityTypesSortOrderEnum

func GetMappingListApiMetadataByEntityTypesSortOrderEnum

func GetMappingListApiMetadataByEntityTypesSortOrderEnum(val string) (ListApiMetadataByEntityTypesSortOrderEnum, bool)

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

type 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
}

ListApiMetadataRequest wrapper for the ListApiMetadata operation

See also

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.

func (ListApiMetadataRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListApiMetadataRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListApiMetadataRequest) RetryPolicy

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

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

func (ListApiMetadataRequest) String

func (request ListApiMetadataRequest) String() string

func (ListApiMetadataRequest) ValidateEnumValue

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

type ListApiMetadataResponse

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

ListApiMetadataResponse wrapper for the ListApiMetadata operation

func (ListApiMetadataResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListApiMetadataResponse) String

func (response ListApiMetadataResponse) String() string

type ListApiMetadataSortByEnum

type ListApiMetadataSortByEnum string

ListApiMetadataSortByEnum Enum with underlying type: string

const (
	ListApiMetadataSortByTimecreated ListApiMetadataSortByEnum = "timeCreated"
	ListApiMetadataSortByDisplayname ListApiMetadataSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListApiMetadataSortByEnum

func GetListApiMetadataSortByEnumValues

func GetListApiMetadataSortByEnumValues() []ListApiMetadataSortByEnum

GetListApiMetadataSortByEnumValues Enumerates the set of values for ListApiMetadataSortByEnum

func GetMappingListApiMetadataSortByEnum

func GetMappingListApiMetadataSortByEnum(val string) (ListApiMetadataSortByEnum, bool)

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

type ListApiMetadataSortOrderEnum

type ListApiMetadataSortOrderEnum string

ListApiMetadataSortOrderEnum Enum with underlying type: string

const (
	ListApiMetadataSortOrderAsc  ListApiMetadataSortOrderEnum = "ASC"
	ListApiMetadataSortOrderDesc ListApiMetadataSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListApiMetadataSortOrderEnum

func GetListApiMetadataSortOrderEnumValues

func GetListApiMetadataSortOrderEnumValues() []ListApiMetadataSortOrderEnum

GetListApiMetadataSortOrderEnumValues Enumerates the set of values for ListApiMetadataSortOrderEnum

func GetMappingListApiMetadataSortOrderEnum

func GetMappingListApiMetadataSortOrderEnum(val string) (ListApiMetadataSortOrderEnum, bool)

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

type 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
}

ListPrivilegedApiControlsRequest wrapper for the ListPrivilegedApiControls operation

See also

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.

func (ListPrivilegedApiControlsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListPrivilegedApiControlsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListPrivilegedApiControlsRequest) RetryPolicy

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

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

func (ListPrivilegedApiControlsRequest) String

func (request ListPrivilegedApiControlsRequest) String() string

func (ListPrivilegedApiControlsRequest) ValidateEnumValue

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

type ListPrivilegedApiControlsResponse

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

ListPrivilegedApiControlsResponse wrapper for the ListPrivilegedApiControls operation

func (ListPrivilegedApiControlsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListPrivilegedApiControlsResponse) String

func (response ListPrivilegedApiControlsResponse) String() string

type ListPrivilegedApiControlsSortByEnum

type ListPrivilegedApiControlsSortByEnum string

ListPrivilegedApiControlsSortByEnum Enum with underlying type: string

const (
	ListPrivilegedApiControlsSortByTimecreated ListPrivilegedApiControlsSortByEnum = "timeCreated"
	ListPrivilegedApiControlsSortByDisplayname ListPrivilegedApiControlsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListPrivilegedApiControlsSortByEnum

func GetListPrivilegedApiControlsSortByEnumValues

func GetListPrivilegedApiControlsSortByEnumValues() []ListPrivilegedApiControlsSortByEnum

GetListPrivilegedApiControlsSortByEnumValues Enumerates the set of values for ListPrivilegedApiControlsSortByEnum

func GetMappingListPrivilegedApiControlsSortByEnum

func GetMappingListPrivilegedApiControlsSortByEnum(val string) (ListPrivilegedApiControlsSortByEnum, bool)

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

type ListPrivilegedApiControlsSortOrderEnum

type ListPrivilegedApiControlsSortOrderEnum string

ListPrivilegedApiControlsSortOrderEnum Enum with underlying type: string

const (
	ListPrivilegedApiControlsSortOrderAsc  ListPrivilegedApiControlsSortOrderEnum = "ASC"
	ListPrivilegedApiControlsSortOrderDesc ListPrivilegedApiControlsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListPrivilegedApiControlsSortOrderEnum

func GetListPrivilegedApiControlsSortOrderEnumValues

func GetListPrivilegedApiControlsSortOrderEnumValues() []ListPrivilegedApiControlsSortOrderEnum

GetListPrivilegedApiControlsSortOrderEnumValues Enumerates the set of values for ListPrivilegedApiControlsSortOrderEnum

func GetMappingListPrivilegedApiControlsSortOrderEnum

func GetMappingListPrivilegedApiControlsSortOrderEnum(val string) (ListPrivilegedApiControlsSortOrderEnum, bool)

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

type 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
}

ListPrivilegedApiRequestsRequest wrapper for the ListPrivilegedApiRequests operation

See also

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.

func (ListPrivilegedApiRequestsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListPrivilegedApiRequestsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListPrivilegedApiRequestsRequest) RetryPolicy

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

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

func (ListPrivilegedApiRequestsRequest) String

func (request ListPrivilegedApiRequestsRequest) String() string

func (ListPrivilegedApiRequestsRequest) ValidateEnumValue

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

type ListPrivilegedApiRequestsResponse

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

ListPrivilegedApiRequestsResponse wrapper for the ListPrivilegedApiRequests operation

func (ListPrivilegedApiRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListPrivilegedApiRequestsResponse) String

func (response ListPrivilegedApiRequestsResponse) String() string

type ListPrivilegedApiRequestsSortByEnum

type ListPrivilegedApiRequestsSortByEnum string

ListPrivilegedApiRequestsSortByEnum Enum with underlying type: string

const (
	ListPrivilegedApiRequestsSortByTimecreated ListPrivilegedApiRequestsSortByEnum = "timeCreated"
	ListPrivilegedApiRequestsSortByDisplayname ListPrivilegedApiRequestsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListPrivilegedApiRequestsSortByEnum

func GetListPrivilegedApiRequestsSortByEnumValues

func GetListPrivilegedApiRequestsSortByEnumValues() []ListPrivilegedApiRequestsSortByEnum

GetListPrivilegedApiRequestsSortByEnumValues Enumerates the set of values for ListPrivilegedApiRequestsSortByEnum

func GetMappingListPrivilegedApiRequestsSortByEnum

func GetMappingListPrivilegedApiRequestsSortByEnum(val string) (ListPrivilegedApiRequestsSortByEnum, bool)

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

type ListPrivilegedApiRequestsSortOrderEnum

type ListPrivilegedApiRequestsSortOrderEnum string

ListPrivilegedApiRequestsSortOrderEnum Enum with underlying type: string

const (
	ListPrivilegedApiRequestsSortOrderAsc  ListPrivilegedApiRequestsSortOrderEnum = "ASC"
	ListPrivilegedApiRequestsSortOrderDesc ListPrivilegedApiRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListPrivilegedApiRequestsSortOrderEnum

func GetListPrivilegedApiRequestsSortOrderEnumValues

func GetListPrivilegedApiRequestsSortOrderEnumValues() []ListPrivilegedApiRequestsSortOrderEnum

GetListPrivilegedApiRequestsSortOrderEnumValues Enumerates the set of values for ListPrivilegedApiRequestsSortOrderEnum

func GetMappingListPrivilegedApiRequestsSortOrderEnum

func GetMappingListPrivilegedApiRequestsSortOrderEnum(val string) (ListPrivilegedApiRequestsSortOrderEnum, bool)

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

type 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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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.

func (ListWorkRequestErrorsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)

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

type ListWorkRequestErrorsResponse

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest

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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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.

func (ListWorkRequestLogsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)

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

type ListWorkRequestLogsResponse

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest

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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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.

func (ListWorkRequestsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)

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

type ListWorkRequestsResponse

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type ListWorkRequestsStatusEnum

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

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

type OperationStatusEnum

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string

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

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type PrivilegedApiControl

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

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

func (PrivilegedApiControl) String

func (m PrivilegedApiControl) String() string

func (PrivilegedApiControl) ValidateEnumValue

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

type PrivilegedApiControlClient

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

PrivilegedApiControlClient a client for PrivilegedApiControl

func NewPrivilegedApiControlClientWithConfigurationProvider

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

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 (PrivilegedApiControlClient) ChangePrivilegedApiControlCompartment

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

See also

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 (*PrivilegedApiControlClient) ConfigurationProvider

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

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

func (PrivilegedApiControlClient) CreatePrivilegedApiControl

func (client PrivilegedApiControlClient) CreatePrivilegedApiControl(ctx context.Context, request CreatePrivilegedApiControlRequest) (response CreatePrivilegedApiControlResponse, err error)

CreatePrivilegedApiControl Creates a PrivilegedApiControl.

See also

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 (PrivilegedApiControlClient) DeletePrivilegedApiControl

func (client PrivilegedApiControlClient) DeletePrivilegedApiControl(ctx context.Context, request DeletePrivilegedApiControlRequest) (response DeletePrivilegedApiControlResponse, err error)

DeletePrivilegedApiControl Deletes a PrivilegedApiControl.

See also

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 (PrivilegedApiControlClient) GetPrivilegedApiControl

func (client PrivilegedApiControlClient) GetPrivilegedApiControl(ctx context.Context, request GetPrivilegedApiControlRequest) (response GetPrivilegedApiControlResponse, err error)

GetPrivilegedApiControl Gets information about a PrivilegedApiControl.

See also

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 (PrivilegedApiControlClient) ListPrivilegedApiControls

func (client PrivilegedApiControlClient) ListPrivilegedApiControls(ctx context.Context, request ListPrivilegedApiControlsRequest) (response ListPrivilegedApiControlsResponse, err error)

ListPrivilegedApiControls Gets a list of PrivilegedApiControls.

See also

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 (*PrivilegedApiControlClient) SetRegion

func (client *PrivilegedApiControlClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (PrivilegedApiControlClient) UpdatePrivilegedApiControl

func (client PrivilegedApiControlClient) UpdatePrivilegedApiControl(ctx context.Context, request UpdatePrivilegedApiControlRequest) (response UpdatePrivilegedApiControlResponse, err error)

UpdatePrivilegedApiControl Updates a PrivilegedApiControl.

See also

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

type PrivilegedApiControlCollection

type PrivilegedApiControlCollection struct {

	// List of privilegedApiControls.
	Items []PrivilegedApiControlSummary `mandatory:"true" json:"items"`
}

PrivilegedApiControlCollection Results of a privilegedApiControl search. Contains both PrivilegedApiControlSummary items and other information, such as metadata.

func (PrivilegedApiControlCollection) String

func (PrivilegedApiControlCollection) ValidateEnumValue

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

type PrivilegedApiControlLifecycleStateEnum

type PrivilegedApiControlLifecycleStateEnum string

PrivilegedApiControlLifecycleStateEnum Enum with underlying type: string

const (
	PrivilegedApiControlLifecycleStateCreating       PrivilegedApiControlLifecycleStateEnum = "CREATING"
	PrivilegedApiControlLifecycleStateUpdating       PrivilegedApiControlLifecycleStateEnum = "UPDATING"
	PrivilegedApiControlLifecycleStateActive         PrivilegedApiControlLifecycleStateEnum = "ACTIVE"
	PrivilegedApiControlLifecycleStateDeleting       PrivilegedApiControlLifecycleStateEnum = "DELETING"
	PrivilegedApiControlLifecycleStateDeleted        PrivilegedApiControlLifecycleStateEnum = "DELETED"
	PrivilegedApiControlLifecycleStateFailed         PrivilegedApiControlLifecycleStateEnum = "FAILED"
	PrivilegedApiControlLifecycleStateNeedsAttention PrivilegedApiControlLifecycleStateEnum = "NEEDS_ATTENTION"
)

Set of constants representing the allowable values for PrivilegedApiControlLifecycleStateEnum

func GetMappingPrivilegedApiControlLifecycleStateEnum

func GetMappingPrivilegedApiControlLifecycleStateEnum(val string) (PrivilegedApiControlLifecycleStateEnum, bool)

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

func GetPrivilegedApiControlLifecycleStateEnumValues

func GetPrivilegedApiControlLifecycleStateEnumValues() []PrivilegedApiControlLifecycleStateEnum

GetPrivilegedApiControlLifecycleStateEnumValues Enumerates the set of values for PrivilegedApiControlLifecycleStateEnum

type PrivilegedApiControlSummary

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

PrivilegedApiControlSummary Summary information about a PrivilegedApiControl.

func (PrivilegedApiControlSummary) String

func (PrivilegedApiControlSummary) ValidateEnumValue

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

type PrivilegedApiDetails

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

PrivilegedApiDetails It represents the api details of the service

func (PrivilegedApiDetails) String

func (m PrivilegedApiDetails) String() string

func (PrivilegedApiDetails) ValidateEnumValue

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

type PrivilegedApiRequest

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

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.

func (PrivilegedApiRequest) String

func (m PrivilegedApiRequest) String() string

func (PrivilegedApiRequest) ValidateEnumValue

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

type PrivilegedApiRequestCollection

type PrivilegedApiRequestCollection struct {

	// contains PrivilegedApiRequestSummary
	Items []PrivilegedApiRequestSummary `mandatory:"true" json:"items"`
}

PrivilegedApiRequestCollection Results of privilegedApi request search, which contains summary of privilegedApi request.

func (PrivilegedApiRequestCollection) String

func (PrivilegedApiRequestCollection) ValidateEnumValue

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

type PrivilegedApiRequestLifecycleStateEnum

type PrivilegedApiRequestLifecycleStateEnum string

PrivilegedApiRequestLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for PrivilegedApiRequestLifecycleStateEnum

func GetMappingPrivilegedApiRequestLifecycleStateEnum

func GetMappingPrivilegedApiRequestLifecycleStateEnum(val string) (PrivilegedApiRequestLifecycleStateEnum, bool)

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

func GetPrivilegedApiRequestLifecycleStateEnumValues

func GetPrivilegedApiRequestLifecycleStateEnumValues() []PrivilegedApiRequestLifecycleStateEnum

GetPrivilegedApiRequestLifecycleStateEnumValues Enumerates the set of values for PrivilegedApiRequestLifecycleStateEnum

type PrivilegedApiRequestOperationDetails

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

PrivilegedApiRequestOperationDetails It represents the api details of the service

func (PrivilegedApiRequestOperationDetails) String

func (PrivilegedApiRequestOperationDetails) ValidateEnumValue

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

type PrivilegedApiRequestSeverityEnum

type PrivilegedApiRequestSeverityEnum string

PrivilegedApiRequestSeverityEnum Enum with underlying type: string

const (
	PrivilegedApiRequestSeveritySev1 PrivilegedApiRequestSeverityEnum = "SEV_1"
	PrivilegedApiRequestSeveritySev2 PrivilegedApiRequestSeverityEnum = "SEV_2"
	PrivilegedApiRequestSeveritySev3 PrivilegedApiRequestSeverityEnum = "SEV_3"
	PrivilegedApiRequestSeveritySev4 PrivilegedApiRequestSeverityEnum = "SEV_4"
)

Set of constants representing the allowable values for PrivilegedApiRequestSeverityEnum

func GetMappingPrivilegedApiRequestSeverityEnum

func GetMappingPrivilegedApiRequestSeverityEnum(val string) (PrivilegedApiRequestSeverityEnum, bool)

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

func GetPrivilegedApiRequestSeverityEnumValues

func GetPrivilegedApiRequestSeverityEnumValues() []PrivilegedApiRequestSeverityEnum

GetPrivilegedApiRequestSeverityEnumValues Enumerates the set of values for PrivilegedApiRequestSeverityEnum

type PrivilegedApiRequestStateEnum

type PrivilegedApiRequestStateEnum string

PrivilegedApiRequestStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for PrivilegedApiRequestStateEnum

func GetMappingPrivilegedApiRequestStateEnum

func GetMappingPrivilegedApiRequestStateEnum(val string) (PrivilegedApiRequestStateEnum, bool)

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

func GetPrivilegedApiRequestStateEnumValues

func GetPrivilegedApiRequestStateEnumValues() []PrivilegedApiRequestStateEnum

GetPrivilegedApiRequestStateEnumValues Enumerates the set of values for PrivilegedApiRequestStateEnum

type PrivilegedApiRequestSummary

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

PrivilegedApiRequestSummary Summary of access request.

func (PrivilegedApiRequestSummary) String

func (PrivilegedApiRequestSummary) ValidateEnumValue

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

type PrivilegedApiRequestsClient

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

PrivilegedApiRequestsClient a client for PrivilegedApiRequests

func NewPrivilegedApiRequestsClientWithConfigurationProvider

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

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 (PrivilegedApiRequestsClient) ApprovePrivilegedApiRequest

func (client PrivilegedApiRequestsClient) ApprovePrivilegedApiRequest(ctx context.Context, request ApprovePrivilegedApiRequestRequest) (response ApprovePrivilegedApiRequestResponse, err error)

ApprovePrivilegedApiRequest Approves privilegedApi request.

See also

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 (PrivilegedApiRequestsClient) ClosePrivilegedApiRequest

func (client PrivilegedApiRequestsClient) ClosePrivilegedApiRequest(ctx context.Context, request ClosePrivilegedApiRequestRequest) (response ClosePrivilegedApiRequestResponse, err error)

ClosePrivilegedApiRequest Closes privilegedApi request.

See also

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 (*PrivilegedApiRequestsClient) ConfigurationProvider

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

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

func (PrivilegedApiRequestsClient) CreatePrivilegedApiRequest

func (client PrivilegedApiRequestsClient) CreatePrivilegedApiRequest(ctx context.Context, request CreatePrivilegedApiRequestRequest) (response CreatePrivilegedApiRequestResponse, err error)

CreatePrivilegedApiRequest Creates a PrivilegedApiRequest.

See also

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 (PrivilegedApiRequestsClient) GetPrivilegedApiRequest

func (client PrivilegedApiRequestsClient) GetPrivilegedApiRequest(ctx context.Context, request GetPrivilegedApiRequestRequest) (response GetPrivilegedApiRequestResponse, err error)

GetPrivilegedApiRequest Gets information about a PrivilegedApiRequest.

See also

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 (PrivilegedApiRequestsClient) ListPrivilegedApiRequests

func (client PrivilegedApiRequestsClient) ListPrivilegedApiRequests(ctx context.Context, request ListPrivilegedApiRequestsRequest) (response ListPrivilegedApiRequestsResponse, err error)

ListPrivilegedApiRequests Lists all privilegedApi requests in the compartment.

See also

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 (PrivilegedApiRequestsClient) RejectPrivilegedApiRequest

func (client PrivilegedApiRequestsClient) RejectPrivilegedApiRequest(ctx context.Context, request RejectPrivilegedApiRequestRequest) (response RejectPrivilegedApiRequestResponse, err error)

RejectPrivilegedApiRequest Rejects privilegedApi request.

See also

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 (PrivilegedApiRequestsClient) RevokePrivilegedApiRequest

func (client PrivilegedApiRequestsClient) RevokePrivilegedApiRequest(ctx context.Context, request RevokePrivilegedApiRequestRequest) (response RevokePrivilegedApiRequestResponse, err error)

RevokePrivilegedApiRequest Revokes an already approved privilegedApi request.

See also

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 (*PrivilegedApiRequestsClient) SetRegion

func (client *PrivilegedApiRequestsClient) SetRegion(region string)

SetRegion overrides the region of this client.

type PrivilegedApiWorkRequestClient

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

PrivilegedApiWorkRequestClient a client for PrivilegedApiWorkRequest

func NewPrivilegedApiWorkRequestClientWithConfigurationProvider

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

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 (PrivilegedApiWorkRequestClient) CancelWorkRequest

func (client PrivilegedApiWorkRequestClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)

CancelWorkRequest Cancels a work request.

See also

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 (*PrivilegedApiWorkRequestClient) ConfigurationProvider

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

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

func (PrivilegedApiWorkRequestClient) GetWorkRequest

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

GetWorkRequest Gets the details of a work request.

See also

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 (PrivilegedApiWorkRequestClient) ListWorkRequestErrors

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

ListWorkRequestErrors Lists the errors for a work request.

See also

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 (PrivilegedApiWorkRequestClient) ListWorkRequestLogs

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

ListWorkRequestLogs Lists the logs for a work request.

See also

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 (PrivilegedApiWorkRequestClient) ListWorkRequests

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

ListWorkRequests Lists the work requests in a compartment.

See also

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 (*PrivilegedApiWorkRequestClient) SetRegion

func (client *PrivilegedApiWorkRequestClient) SetRegion(region string)

SetRegion overrides the region of this client.

type RejectPrivilegedApiRequestDetails

type RejectPrivilegedApiRequestDetails struct {

	// Comment by the approver explaining why the request is rejected.
	ApproverComment *string `mandatory:"false" json:"approverComment"`
}

RejectPrivilegedApiRequestDetails Summary of why the privilegedApi request was rejected.

func (RejectPrivilegedApiRequestDetails) String

func (RejectPrivilegedApiRequestDetails) ValidateEnumValue

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

type 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
}

RejectPrivilegedApiRequestRequest wrapper for the RejectPrivilegedApiRequest operation

See also

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.

func (RejectPrivilegedApiRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (RejectPrivilegedApiRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (RejectPrivilegedApiRequestRequest) RetryPolicy

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

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

func (RejectPrivilegedApiRequestRequest) String

func (request RejectPrivilegedApiRequestRequest) String() string

func (RejectPrivilegedApiRequestRequest) ValidateEnumValue

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

type RejectPrivilegedApiRequestResponse

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

RejectPrivilegedApiRequestResponse wrapper for the RejectPrivilegedApiRequest operation

func (RejectPrivilegedApiRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (RejectPrivilegedApiRequestResponse) String

func (response RejectPrivilegedApiRequestResponse) String() string

type RevokePrivilegedApiRequestDetails

type RevokePrivilegedApiRequestDetails struct {

	// Comment specified by the approver explaining why the approval is revoked.
	ApproverComment *string `mandatory:"false" json:"approverComment"`
}

RevokePrivilegedApiRequestDetails Summary of why the already approved privilegedApi request was revoked.

func (RevokePrivilegedApiRequestDetails) String

func (RevokePrivilegedApiRequestDetails) ValidateEnumValue

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

type 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
}

RevokePrivilegedApiRequestRequest wrapper for the RevokePrivilegedApiRequest operation

See also

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.

func (RevokePrivilegedApiRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (RevokePrivilegedApiRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (RevokePrivilegedApiRequestRequest) RetryPolicy

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

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

func (RevokePrivilegedApiRequestRequest) String

func (request RevokePrivilegedApiRequestRequest) String() string

func (RevokePrivilegedApiRequestRequest) ValidateEnumValue

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

type RevokePrivilegedApiRequestResponse

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

RevokePrivilegedApiRequestResponse wrapper for the RevokePrivilegedApiRequest operation

func (RevokePrivilegedApiRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (RevokePrivilegedApiRequestResponse) String

func (response RevokePrivilegedApiRequestResponse) String() string

type SortOrderEnum

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type UpdatePrivilegedApiControlDetails

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

UpdatePrivilegedApiControlDetails The data to update a PrivilegedApiControl.

func (UpdatePrivilegedApiControlDetails) String

func (UpdatePrivilegedApiControlDetails) ValidateEnumValue

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

type 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
}

UpdatePrivilegedApiControlRequest wrapper for the UpdatePrivilegedApiControl operation

See also

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.

func (UpdatePrivilegedApiControlRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdatePrivilegedApiControlRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdatePrivilegedApiControlRequest) RetryPolicy

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

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

func (UpdatePrivilegedApiControlRequest) String

func (request UpdatePrivilegedApiControlRequest) String() string

func (UpdatePrivilegedApiControlRequest) ValidateEnumValue

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

type UpdatePrivilegedApiControlResponse

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

UpdatePrivilegedApiControlResponse wrapper for the UpdatePrivilegedApiControl operation

func (UpdatePrivilegedApiControlResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdatePrivilegedApiControlResponse) String

func (response UpdatePrivilegedApiControlResponse) String() string

type WorkRequest

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

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.

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

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

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

type WorkRequestError

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

WorkRequestError An error encountered while performing an operation that is tracked by a work request.

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

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

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

type WorkRequestErrorCollection

type WorkRequestErrorCollection struct {

	// A list of work request errors.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection A list of work request errors. Can contain both errors and other information, such as metadata.

func (WorkRequestErrorCollection) String

func (WorkRequestErrorCollection) ValidateEnumValue

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

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

type WorkRequestLogEntry

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

WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

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

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

type WorkRequestLogEntryCollection

type WorkRequestLogEntryCollection struct {

	// A list of work request log entries.
	Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

WorkRequestLogEntryCollection A list of work request logs. Can contain both logs and other information, such as metadata.

func (WorkRequestLogEntryCollection) String

func (WorkRequestLogEntryCollection) ValidateEnumValue

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

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

type WorkRequestResource

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

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

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

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

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

type WorkRequestResourceMetadataKeyEnum

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string

const (
	WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

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

func GetWorkRequestResourceMetadataKeyEnumValues

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSummary

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

WorkRequestSummary Summary information about an asynchronous work request.

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

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

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

type WorkRequestSummaryCollection

type WorkRequestSummaryCollection struct {

	// A list of work requests.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestSummaryCollection A list of work requests. Can contain both work requests and other information, such as metadata.

func (WorkRequestSummaryCollection) String

func (WorkRequestSummaryCollection) ValidateEnumValue

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

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

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL