Uses of Package
com.oracle.bmc.apigateway.model

Packages that use com.oracle.bmc.apigateway.model

Package	Description
com.oracle.bmc.apigateway
com.oracle.bmc.apigateway.model
com.oracle.bmc.apigateway.requests
com.oracle.bmc.apigateway.responses

Classes in com.oracle.bmc.apigateway.model used by com.oracle.bmc.apigateway

Class and Description
Api.LifecycleState The current state of the API.
ApiSummary A summary of the API.
Certificate.LifecycleState The current state of the certificate.
CertificateSummary A summary of the certificate.
Deployment.LifecycleState The current state of the deployment.
DeploymentSummary A summary of the deployment.
Gateway.LifecycleState The current state of the gateway.
GatewaySummary A summary of the gateway.
WorkRequestError An error encountered while executing a work request.
WorkRequestLog A log message from the execution of a work request.
WorkRequestSummary A summary of the work request.

Classes in com.oracle.bmc.apigateway.model used by com.oracle.bmc.apigateway.model

Class and Description
AccessLogPolicy Configures the logging policies for the access logs of an API Deployment.
AccessLogPolicy.Builder
AnonymousRouteAuthorizationPolicy For a type of ANONYMOUS, an authenticated API must have the "isAnonymousAccessAllowed" property set to "true" in the authentication policy.
AnonymousRouteAuthorizationPolicy.Builder
AnyOfRouteAuthorizationPolicy If authentication has been performed, validate whether the request scope (if any) applies to this route.
AnyOfRouteAuthorizationPolicy.Builder
Api An API is simple container for an API Specification.
Api.Builder
Api.LifecycleState The current state of the API.
ApiCollection Collection of API summaries.
ApiCollection.Builder
ApiSpecification The logical configuration of the API exposed by a deployment.
ApiSpecification.Builder
ApiSpecificationLoggingPolicies Policies controlling the pushing of logs to OCI Public Logging.
ApiSpecificationLoggingPolicies.Builder
ApiSpecificationRequestPolicies Global behavior applied to all requests received by the API.
ApiSpecificationRequestPolicies.Builder
ApiSpecificationRoute A single route that forwards requests to a particular backend and may contain some additional policies.
ApiSpecificationRoute.Builder
ApiSpecificationRoute.Methods
ApiSpecificationRouteBackend The backend to forward requests to.
ApiSpecificationRouteBackend.Type Type of the API backend.
ApiSpecificationRouteRequestPolicies Behavior applied to any requests received by the API on this route.
ApiSpecificationRouteRequestPolicies.Builder
ApiSpecificationRouteResponsePolicies Behavior applied to any responses sent by the API for requests on this route.
ApiSpecificationRouteResponsePolicies.Builder
ApiSummary A summary of the API.
ApiSummary.Builder
ApiSummary.LifecycleState The current state of the API.
ApiValidationDetail Detail of a single error or warning.
ApiValidationDetail.Builder
ApiValidationDetail.Severity Severity of the issue.
ApiValidationDetails Detail of an error or warning.
ApiValidationDetails.Builder
ApiValidationDetails.Result Result of the validation.
ApiValidationResult The result of single validation.
ApiValidationResult.Builder
ApiValidationResult.Result Result of the validation.
ApiValidations The result of validations conducted on the API.
ApiValidations.Builder
AuthenticationOnlyRouteAuthorizationPolicy Only authentication is performed for the request and authorization is skipped.
AuthenticationOnlyRouteAuthorizationPolicy.Builder
AuthenticationPolicy Information on how to authenticate incoming requests.
AuthenticationPolicy.Type Type of the authentication policy to use.
Certificate A certificate contains information to be installed on a gateway to secure the traffic going through it.
Certificate.Builder
Certificate.LifecycleState The current state of the certificate.
CertificateCollection Collection of certificate summaries.
CertificateCollection.Builder
CertificateSummary A summary of the certificate.
CertificateSummary.Builder
ChangeApiCompartmentDetails The new compartment details for the API.
ChangeApiCompartmentDetails.Builder
ChangeCertificateCompartmentDetails The new compartment details for the certificate.
ChangeCertificateCompartmentDetails.Builder
ChangeDeploymentCompartmentDetails The new compartment details for the deployment.
ChangeDeploymentCompartmentDetails.Builder
ChangeGatewayCompartmentDetails The new compartment details for the gateway.
ChangeGatewayCompartmentDetails.Builder
CorsPolicy Enable CORS (Cross-Origin-Resource-Sharing) request handling.
CorsPolicy.Builder
CreateApiDetails Information about the new API.
CreateApiDetails.Builder
CreateCertificateDetails Information about a new certificate.
CreateCertificateDetails.Builder
CreateDeploymentDetails Information about a new deployment.
CreateDeploymentDetails.Builder
CreateGatewayDetails Information about the new gateway.
CreateGatewayDetails.Builder
CustomAuthenticationPolicy Use a function to validate a custom header or query parameter sent with the request authentication.
CustomAuthenticationPolicy.Builder
Deployment A deployment deploys an API on a gateway.
Deployment.Builder
Deployment.LifecycleState The current state of the deployment.
DeploymentCollection Collection of deployment summaries.
DeploymentCollection.Builder
DeploymentSummary A summary of the deployment.
DeploymentSummary.Builder
ExecutionLogPolicy Configures the logging policies for the execution logs of an API Deployment.
ExecutionLogPolicy.Builder
ExecutionLogPolicy.LogLevel Specifies the log level used to control logging output of execution logs.
FilterHeaderPolicy Filter HTTP headers as they pass through the gateway.
FilterHeaderPolicy.Builder
FilterHeaderPolicy.Type BLOCK drops any headers that are in the list of items, so it acts as an exclusion list.
FilterHeaderPolicyItem A header to drop (with BLOCK) or pass through (with ALLOW).
FilterHeaderPolicyItem.Builder
FilterQueryParameterPolicy Filter parameters from the query string as they pass through the gateway.
FilterQueryParameterPolicy.Builder
FilterQueryParameterPolicy.Type BLOCK drops any query parameters that are in the list of items, so it acts as an exclusion list.
FilterQueryParameterPolicyItem A query parameter to drop (with BLOCK) or pass through (with ALLOW).
FilterQueryParameterPolicyItem.Builder
Gateway A gateway is a virtual network appliance in a regional subnet.
Gateway.Builder
Gateway.EndpointType Gateway endpoint type.
Gateway.LifecycleState The current state of the gateway.
GatewayCollection Collection of gateway summaries.
GatewayCollection.Builder
GatewaySummary A summary of the gateway.
GatewaySummary.Builder
HeaderFieldSpecification Header in key/value pair.
HeaderFieldSpecification.Builder
HeaderTransformationPolicy A set of transformations to apply to HTTP headers that pass through the gateway.
HeaderTransformationPolicy.Builder
HTTPBackend Send the request to an HTTP backend.
HTTPBackend.Builder
IpAddress IP address associated with the gateway.
IpAddress.Builder
JsonWebKey A JSON Web Key that represents the public key used for verifying the JWT signature.
JsonWebKey.Builder
JsonWebKey.KeyOps
JsonWebKey.Kty The key type.
JsonWebKey.Use The intended use of the public key.
JsonWebTokenClaim An individual JWT claim.
JsonWebTokenClaim.Builder
JwtAuthenticationPolicy Validate a JWT token present in the header or query parameter.
JwtAuthenticationPolicy.Builder
OracleFunctionBackend Send the request to an Oracle Functions function.
OracleFunctionBackend.Builder
PemEncodedPublicKey A PEM-encoded public key used for verifying the JWT signature.
PemEncodedPublicKey.Builder
PublicKeySet A set of Public Keys that will be used to verify the JWT signature.
PublicKeySet.Type Type of the public key set.
QueryParameterTransformationPolicy A set of transformations to apply to query parameters that pass through the gateway.
QueryParameterTransformationPolicy.Builder
RateLimitingPolicy Limit the number of requests that should be handled for the specified window using a specfic key.
RateLimitingPolicy.Builder
RateLimitingPolicy.RateKey The key used to group requests together.
RemoteJsonWebKeySet A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature.
RemoteJsonWebKeySet.Builder
RenameHeaderPolicy Rename HTTP headers as they pass through the gateway.
RenameHeaderPolicy.Builder
RenameHeaderPolicyItem The value will be a copy of the original value of the source header and will not be affected by any other transformation policies applied to that header.
RenameHeaderPolicyItem.Builder
RenameQueryParameterPolicy Rename parameters on the query string as they pass through the gateway.
RenameQueryParameterPolicy.Builder
RenameQueryParameterPolicyItem The value will be a copy of the original value of the source parameter and will not be affected by any other transformation policies applied to that parameter.
RenameQueryParameterPolicyItem.Builder
RouteAuthorizationPolicy If authentication has been performed, validate whether the request scope (if any) applies to this route.
RouteAuthorizationPolicy.Type Indicates how authorization should be applied.
SetHeaderPolicy Set HTTP headers as they pass through the gateway.
SetHeaderPolicy.Builder
SetHeaderPolicyItem Set will add a new header if it was not in the original request.
SetHeaderPolicyItem.Builder
SetHeaderPolicyItem.IfExists If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
SetQueryParameterPolicy Set parameters on the query string as they pass through the gateway.
SetQueryParameterPolicy.Builder
SetQueryParameterPolicyItem Set will add a new query parameter if it was not in the original request.
SetQueryParameterPolicyItem.Builder
SetQueryParameterPolicyItem.IfExists If a query parameter with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
StaticPublicKey A static public key which is used to verify the JWT signature.
StaticPublicKey.Format The format of the public key.
StaticPublicKeySet A set of static public keys that will be used to verify the JWT signature.
StaticPublicKeySet.Builder
StockResponseBackend Send the request to a mock backend.
StockResponseBackend.Builder
UpdateApiDetails The information to be updated.
UpdateApiDetails.Builder
UpdateCertificateDetails The information to be updated.
UpdateCertificateDetails.Builder
UpdateDeploymentDetails The information to be updated.
UpdateDeploymentDetails.Builder
UpdateGatewayDetails The information to be updated.
UpdateGatewayDetails.Builder
WorkRequest A description of the work request status.
WorkRequest.Builder
WorkRequest.OperationType The type of the work request.
WorkRequest.Status The status of the work request.
WorkRequestCollection Collection of work request summaries.
WorkRequestCollection.Builder
WorkRequestError An error encountered while executing a work request.
WorkRequestError.Builder
WorkRequestErrorCollection Collection of work request errors.
WorkRequestErrorCollection.Builder
WorkRequestLog A log message from the execution of a work request.
WorkRequestLog.Builder
WorkRequestLogCollection Collection of work request logs.
WorkRequestLogCollection.Builder
WorkRequestResource A resource created or operated on by a work request.
WorkRequestResource.ActionType The way in which this resource is affected by the work tracked in the work request.
WorkRequestResource.Builder
WorkRequestSummary A summary of the work request.
WorkRequestSummary.Builder

Classes in com.oracle.bmc.apigateway.model used by com.oracle.bmc.apigateway.requests

Class and Description
ApiSummary.LifecycleState The current state of the API.
Certificate.LifecycleState The current state of the certificate.
ChangeApiCompartmentDetails The new compartment details for the API.
ChangeCertificateCompartmentDetails The new compartment details for the certificate.
ChangeDeploymentCompartmentDetails The new compartment details for the deployment.
ChangeGatewayCompartmentDetails The new compartment details for the gateway.
CreateApiDetails Information about the new API.
CreateCertificateDetails Information about a new certificate.
CreateDeploymentDetails Information about a new deployment.
CreateGatewayDetails Information about the new gateway.
Deployment.LifecycleState The current state of the deployment.
Gateway.LifecycleState The current state of the gateway.
UpdateApiDetails The information to be updated.
UpdateCertificateDetails The information to be updated.
UpdateDeploymentDetails The information to be updated.
UpdateGatewayDetails The information to be updated.

Classes in com.oracle.bmc.apigateway.model used by com.oracle.bmc.apigateway.responses

Class and Description
Api An API is simple container for an API Specification.
ApiCollection Collection of API summaries.
ApiSpecification The logical configuration of the API exposed by a deployment.
ApiValidations The result of validations conducted on the API.
Certificate A certificate contains information to be installed on a gateway to secure the traffic going through it.
CertificateCollection Collection of certificate summaries.
Deployment A deployment deploys an API on a gateway.
DeploymentCollection Collection of deployment summaries.
Gateway A gateway is a virtual network appliance in a regional subnet.
GatewayCollection Collection of gateway summaries.
WorkRequest A description of the work request status.
WorkRequestCollection Collection of work request summaries.
WorkRequestErrorCollection Collection of work request errors.
WorkRequestLogCollection Collection of work request logs.