package
17.4.0+incompatible
Repository: https://github.com/oracle/oci-go-sdk.git
Documentation: pkg.go.dev

# Functions

GetApiSpecificationRouteBackendTypeEnumValues Enumerates the set of values for ApiSpecificationRouteBackendTypeEnum.
GetApiSpecificationRouteMethodsEnumValues Enumerates the set of values for ApiSpecificationRouteMethodsEnum.
GetAuthenticationPolicyTypeEnumValues Enumerates the set of values for AuthenticationPolicyTypeEnum.
GetDeploymentLifecycleStateEnumValues Enumerates the set of values for DeploymentLifecycleStateEnum.
GetExecutionLogPolicyLogLevelEnumValues Enumerates the set of values for ExecutionLogPolicyLogLevelEnum.
GetGatewayEndpointTypeEnumValues Enumerates the set of values for GatewayEndpointTypeEnum.
GetGatewayLifecycleStateEnumValues Enumerates the set of values for GatewayLifecycleStateEnum.
GetListDeploymentsSortByEnumValues Enumerates the set of values for ListDeploymentsSortByEnum.
GetListDeploymentsSortOrderEnumValues Enumerates the set of values for ListDeploymentsSortOrderEnum.
GetListGatewaysSortByEnumValues Enumerates the set of values for ListGatewaysSortByEnum.
GetListGatewaysSortOrderEnumValues Enumerates the set of values for ListGatewaysSortOrderEnum.
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum.
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum.
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum.
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum.
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum.
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum.
GetRateLimitingPolicyRateKeyEnumValues Enumerates the set of values for RateLimitingPolicyRateKeyEnum.
GetRouteAuthorizationPolicyTypeEnumValues Enumerates the set of values for RouteAuthorizationPolicyTypeEnum.
GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum.
GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum.
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum.
NewDeploymentClientWithConfigurationProvider Creates a new default Deployment client with the given configuration provider.
NewDeploymentClientWithOboToken Creates a new default Deployment client with the given configuration provider.
NewGatewayClientWithConfigurationProvider Creates a new default Gateway client with the given configuration provider.
NewGatewayClientWithOboToken Creates a new default Gateway client with the given configuration provider.
NewWorkRequestsClientWithConfigurationProvider Creates a new default WorkRequests client with the given configuration provider.
NewWorkRequestsClientWithOboToken Creates a new default WorkRequests client with the given configuration provider.

# Constants

Set of constants representing the allowable values for ApiSpecificationRouteBackendTypeEnum.
Set of constants representing the allowable values for ApiSpecificationRouteBackendTypeEnum.
Set of constants representing the allowable values for ApiSpecificationRouteBackendTypeEnum.
Set of constants representing the allowable values for ApiSpecificationRouteMethodsEnum.
Set of constants representing the allowable values for ApiSpecificationRouteMethodsEnum.
Set of constants representing the allowable values for ApiSpecificationRouteMethodsEnum.
Set of constants representing the allowable values for ApiSpecificationRouteMethodsEnum.
Set of constants representing the allowable values for ApiSpecificationRouteMethodsEnum.
Set of constants representing the allowable values for ApiSpecificationRouteMethodsEnum.
Set of constants representing the allowable values for ApiSpecificationRouteMethodsEnum.
Set of constants representing the allowable values for ApiSpecificationRouteMethodsEnum.
Set of constants representing the allowable values for AuthenticationPolicyTypeEnum.
Set of constants representing the allowable values for DeploymentLifecycleStateEnum.
Set of constants representing the allowable values for DeploymentLifecycleStateEnum.
Set of constants representing the allowable values for DeploymentLifecycleStateEnum.
Set of constants representing the allowable values for DeploymentLifecycleStateEnum.
Set of constants representing the allowable values for DeploymentLifecycleStateEnum.
Set of constants representing the allowable values for DeploymentLifecycleStateEnum.
Set of constants representing the allowable values for ExecutionLogPolicyLogLevelEnum.
Set of constants representing the allowable values for ExecutionLogPolicyLogLevelEnum.
Set of constants representing the allowable values for ExecutionLogPolicyLogLevelEnum.
Set of constants representing the allowable values for GatewayEndpointTypeEnum.
Set of constants representing the allowable values for GatewayEndpointTypeEnum.
Set of constants representing the allowable values for GatewayLifecycleStateEnum.
Set of constants representing the allowable values for GatewayLifecycleStateEnum.
Set of constants representing the allowable values for GatewayLifecycleStateEnum.
Set of constants representing the allowable values for GatewayLifecycleStateEnum.
Set of constants representing the allowable values for GatewayLifecycleStateEnum.
Set of constants representing the allowable values for GatewayLifecycleStateEnum.
Set of constants representing the allowable values for ListDeploymentsSortByEnum.
Set of constants representing the allowable values for ListDeploymentsSortByEnum.
Set of constants representing the allowable values for ListDeploymentsSortOrderEnum.
Set of constants representing the allowable values for ListDeploymentsSortOrderEnum.
Set of constants representing the allowable values for ListGatewaysSortByEnum.
Set of constants representing the allowable values for ListGatewaysSortByEnum.
Set of constants representing the allowable values for ListGatewaysSortOrderEnum.
Set of constants representing the allowable values for ListGatewaysSortOrderEnum.
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum.
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum.
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum.
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum.
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum.
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum.
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum.
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum.
Set of constants representing the allowable values for ListWorkRequestsSortByEnum.
Set of constants representing the allowable values for ListWorkRequestsSortByEnum.
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum.
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum.
Set of constants representing the allowable values for RateLimitingPolicyRateKeyEnum.
Set of constants representing the allowable values for RateLimitingPolicyRateKeyEnum.
Set of constants representing the allowable values for RouteAuthorizationPolicyTypeEnum.
Set of constants representing the allowable values for RouteAuthorizationPolicyTypeEnum.
Set of constants representing the allowable values for RouteAuthorizationPolicyTypeEnum.
Set of constants representing the allowable values for WorkRequestOperationTypeEnum.
Set of constants representing the allowable values for WorkRequestOperationTypeEnum.
Set of constants representing the allowable values for WorkRequestOperationTypeEnum.
Set of constants representing the allowable values for WorkRequestOperationTypeEnum.
Set of constants representing the allowable values for WorkRequestOperationTypeEnum.
Set of constants representing the allowable values for WorkRequestOperationTypeEnum.
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum.
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum.
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum.
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum.
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum.
Set of constants representing the allowable values for WorkRequestStatusEnum.
Set of constants representing the allowable values for WorkRequestStatusEnum.
Set of constants representing the allowable values for WorkRequestStatusEnum.
Set of constants representing the allowable values for WorkRequestStatusEnum.
Set of constants representing the allowable values for WorkRequestStatusEnum.
Set of constants representing the allowable values for WorkRequestStatusEnum.

# Structs

AccessLogPolicy Configures the pushing of access logs to OCI Public Logging.
AnonymousRouteAuthorizationPolicy For a type of ANONYMOUS, an authenticated API must have the "isAnonymousAccessAllowed" property set to "true" in the authentication policy.
AnyOfRouteAuthorizationPolicy If authentication has been performed, validate whether the request scope (if any) applies to this route.
ApiSpecification The logical configuration of the API exposed by a deployment.
ApiSpecificationLoggingPolicies Policies controlling the pushing of logs to OCI Public Logging.
ApiSpecificationRequestPolicies Global behavior applied to all requests received by the API.
ApiSpecificationRoute A single route that forwards requests to a particular backend and may contain some additional policies.
ApiSpecificationRouteRequestPolicies Behavior applied to any requests received by the API on this route.
AuthenticationOnlyRouteAuthorizationPolicy Only authentication is performed for the request and authorization is skipped.
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation.
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation.
ChangeDeploymentCompartmentDetails The new compartment details for the deployment.
ChangeDeploymentCompartmentRequest wrapper for the ChangeDeploymentCompartment operation.
ChangeDeploymentCompartmentResponse wrapper for the ChangeDeploymentCompartment operation.
ChangeGatewayCompartmentDetails The new compartment details for the gateway.
ChangeGatewayCompartmentRequest wrapper for the ChangeGatewayCompartment operation.
ChangeGatewayCompartmentResponse wrapper for the ChangeGatewayCompartment operation.
CorsPolicy Enable CORS (Cross-Origin-Resource-Sharing) request handling.
CreateDeploymentDetails Information about a new deployment.
CreateDeploymentRequest wrapper for the CreateDeployment operation.
CreateDeploymentResponse wrapper for the CreateDeployment operation.
CreateGatewayDetails Information about the new gateway.
CreateGatewayRequest wrapper for the CreateGateway operation.
CreateGatewayResponse wrapper for the CreateGateway operation.
CustomAuthenticationPolicy Use a function to validate a custom header or query parameter sent with the request authentication.
DeleteDeploymentRequest wrapper for the DeleteDeployment operation.
DeleteDeploymentResponse wrapper for the DeleteDeployment operation.
DeleteGatewayRequest wrapper for the DeleteGateway operation.
DeleteGatewayResponse wrapper for the DeleteGateway operation.
Deployment A deployment deploys an API on a gateway.
DeploymentClient a client for Deployment.
DeploymentCollection Collection of deployment summaries.
DeploymentSummary A summary of the deployment.
ExecutionLogPolicy Configures the pushing of execution logs to OCI Public Logging.
Gateway A gateway is a virtual network appliance in a regional subnet.
GatewayClient a client for Gateway.
GatewayCollection Collection of gateway summaries.
GatewaySummary A summary of the gateway.
GetDeploymentRequest wrapper for the GetDeployment operation.
GetDeploymentResponse wrapper for the GetDeployment operation.
GetGatewayRequest wrapper for the GetGateway operation.
GetGatewayResponse wrapper for the GetGateway operation.
GetWorkRequestRequest wrapper for the GetWorkRequest operation.
GetWorkRequestResponse wrapper for the GetWorkRequest operation.
HeaderFieldSpecification Header in key/value pair.
HttpBackend Send the request to an HTTP backend.
ListDeploymentsRequest wrapper for the ListDeployments operation.
ListDeploymentsResponse wrapper for the ListDeployments operation.
ListGatewaysRequest wrapper for the ListGateways operation.
ListGatewaysResponse wrapper for the ListGateways operation.
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation.
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation.
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation.
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation.
ListWorkRequestsRequest wrapper for the ListWorkRequests operation.
ListWorkRequestsResponse wrapper for the ListWorkRequests operation.
OracleFunctionBackend Send the request to an Oracle Functions function.
RateLimitingPolicy Limit the number of requests that should be handled for the specified window using a specfic key.
StockResponseBackend Send the request to a mock backend.
UpdateDeploymentDetails The information to be updated.
UpdateDeploymentRequest wrapper for the UpdateDeployment operation.
UpdateDeploymentResponse wrapper for the UpdateDeployment operation.
UpdateGatewayDetails The information to be updated.
UpdateGatewayRequest wrapper for the UpdateGateway operation.
UpdateGatewayResponse wrapper for the UpdateGateway operation.
WorkRequest A description of the work request status.
WorkRequestCollection Collection of work request summaries.
WorkRequestError An error encountered while executing a work request.
WorkRequestErrorCollection Collection of work request errors.
WorkRequestLog A log message from the execution of a work request.
WorkRequestLogCollection Collection of work request logs.
WorkRequestResource A resource created or operated on by a work request.
WorkRequestsClient a client for WorkRequests.
WorkRequestSummary A summary of the work request.

# Interfaces

ApiSpecificationRouteBackend The backend to forward requests to.
AuthenticationPolicy Information on how to authenticate incoming requests.
RouteAuthorizationPolicy If authentication has been performed, validate whether the request scope (if any) applies to this route.

# Type aliases

ApiSpecificationRouteBackendTypeEnum Enum with underlying type: string.
ApiSpecificationRouteMethodsEnum Enum with underlying type: string.
AuthenticationPolicyTypeEnum Enum with underlying type: string.
DeploymentLifecycleStateEnum Enum with underlying type: string.
ExecutionLogPolicyLogLevelEnum Enum with underlying type: string.
GatewayEndpointTypeEnum Enum with underlying type: string.
GatewayLifecycleStateEnum Enum with underlying type: string.
ListDeploymentsSortByEnum Enum with underlying type: string.
ListDeploymentsSortOrderEnum Enum with underlying type: string.
ListGatewaysSortByEnum Enum with underlying type: string.
ListGatewaysSortOrderEnum Enum with underlying type: string.
ListWorkRequestErrorsSortByEnum Enum with underlying type: string.
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string.
ListWorkRequestLogsSortByEnum Enum with underlying type: string.
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string.
ListWorkRequestsSortByEnum Enum with underlying type: string.
ListWorkRequestsSortOrderEnum Enum with underlying type: string.
RateLimitingPolicyRateKeyEnum Enum with underlying type: string.
RouteAuthorizationPolicyTypeEnum Enum with underlying type: string.
WorkRequestOperationTypeEnum Enum with underlying type: string.
WorkRequestResourceActionTypeEnum Enum with underlying type: string.
WorkRequestStatusEnum Enum with underlying type: string.