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.
Sdk.LifecycleState The current state of the SDK.
SdkLanguageTypeSummary SDK target language details.
SdkSummary A summary of the SDK.
Subscriber.LifecycleState The current state of the subscriber.
SubscriberSummary A summary of a subscriber.
UsagePlan.LifecycleState The current state of the usage plan.
UsagePlanSummary A summary of the usage plan.
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
AdditionalValidationPolicy Additional JWT validation checks.
AdditionalValidationPolicy.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
AnyOfSelectionKey When dynamically routing and dynamically authenticating requests, the route or authentication server associated with a set of selection keys is used if the context variable in an incoming request exactly matches one of the keys in the set.
AnyOfSelectionKey.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.
AuthenticationServerPolicy Policy for the details regarding each authentication server under dynamic authentication.
AuthenticationServerPolicy.Builder
BodyValidationRequestPolicy Validate the payload body of the incoming API requests on a specific route.
BodyValidationRequestPolicy.Builder
BodyValidationRequestPolicy.ValidationMode Validation behavior mode.
CaBundle Reference to the CA bundle that should be used on the gateway Note: Objects should always be created or deserialized using the Builder.
CaBundle.Type Type of the CA bundle
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
CertificatesCaBundle CA bundle from Certificates Service that should be used on the gateway for TLS validation Note: Objects should always be created or deserialized using the CertificatesCaBundle.Builder.
CertificatesCaBundle.Builder
CertificatesCertificateAuthority Certificate Authority from Certificates Service that should be used on the gateway for TLS validation Note: Objects should always be created or deserialized using the CertificatesCertificateAuthority.Builder.
CertificatesCertificateAuthority.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
ChangeSubscriberCompartmentDetails The new compartment details for the subscriber.
ChangeSubscriberCompartmentDetails.Builder
ChangeUsagePlanCompartmentDetails The new compartment details for the usage plan.
ChangeUsagePlanCompartmentDetails.Builder
Client A Client.
Client.Builder
ClientAppDetails Client App Credential details.
ClientAppDetails.Type To specify where the Client App details should be taken from.
ClientSummary A summary of a client.
ClientSummary.Builder
ContentValidation Content validation properties.
ContentValidation.ValidationType Validation type defines the content validation method.
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
CreateSdkDetails Information about the new SDK.
CreateSdkDetails.Builder
CreateSubscriberDetails Information about a new subscriber.
CreateSubscriberDetails.Builder
CreateUsagePlanDetails Information about a new usage plan.
CreateUsagePlanDetails.Builder
CustomAuthenticationPolicy Use a function to validate a custom header or query parameter sent with the request authentication.
CustomAuthenticationPolicy.Builder
CustomClientAppDetails Client App Credentials to be provided again.
CustomClientAppDetails.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
DiscoveryUriSourceUriDetails Discovery Uri information.
DiscoveryUriSourceUriDetails.Builder
DynamicAuthenticationPolicy Policy on how to authenticate requests when multiple authentication options are configured for a deployment.
DynamicAuthenticationPolicy.Builder
DynamicRoutingBackend Send the request to the backend dynamically selected based on the incoming request’s context.
DynamicRoutingBackend.Builder
DynamicRoutingTypeRoutingBackend Policy for the details regarding each routing backend under dynamic routing.
DynamicRoutingTypeRoutingBackend.Builder
DynamicSelectionKey Base policy for defining how to match the context variable in an incoming request with selection keys when dynamically routing and dynamically authenticating requests.
DynamicSelectionKey.Type Type of the selection key.
Entitlement A usage plan entitlement, comprising of rate limits, quotas and the deployments they are applied to.
Entitlement.Builder
EntitlementSummary A summary of an entitlement included in a usage plan.
EntitlementSummary.Builder
EntitlementTarget An entitlement target, describing which deployment the entitlement should be applied to.
EntitlementTarget.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.
ExternalRespCache Connection details for an external RESP based cache store for Response Caching.
ExternalRespCache.Builder
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
FixedTTLResponseCacheStorePolicy How a response from a backend is cached in the Response Cache.
FixedTTLResponseCacheStorePolicy.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
HeaderValidationItem Header validation properties.
HeaderValidationItem.Builder
HeaderValidationRequestPolicy Validate the HTTP headers on the incoming API requests on a specific route.
HeaderValidationRequestPolicy.Builder
HeaderValidationRequestPolicy.ValidationMode Validation behavior mode.
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
ModifyResponseValidationFailurePolicy Policy to specify how to modify the response code, body and headers.
ModifyResponseValidationFailurePolicy.Builder
MutualTlsDetails Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
MutualTlsDetails.Builder
NoCache Configures the gateway with no caching.
NoCache.Builder
NoContentValidation No content validation properties.
NoContentValidation.Builder
OAuth2LogoutBackend Backend which when called triggers OAuth2 logout.
OAuth2LogoutBackend.Builder
OAuth2ResponseValidationFailurePolicy Policy to specify OAuth2 flow configuration.
OAuth2ResponseValidationFailurePolicy.Builder
OAuth2ResponseValidationFailurePolicy.ResponseType Response Type.
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
QueryParameterValidationItem Query parameter validation properties.
QueryParameterValidationItem.Builder
QueryParameterValidationRequestPolicy Validate the URL query parameters on the incoming API requests on a specific route.
QueryParameterValidationRequestPolicy.Builder
QueryParameterValidationRequestPolicy.ValidationMode Validation behavior mode.
Quota Quota policy for a usage plan.
Quota.Builder
Quota.OperationOnBreach What the usage plan will do when a quota is breached: REJECT will allow no further requests ALLOW will continue to allow further requests
Quota.ResetPolicy The policy that controls when quotas will reset.
Quota.Unit The unit of time over which quotas are calculated.
RateLimit Rate-limiting policy for a usage plan.
RateLimit.Builder
RateLimit.Unit The unit of time over which rate limits are calculated.
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
RequestParameterValidation Common parameter validation properties.
RequestParameterValidation.Builder
ResponseCacheDetails Base Gateway response cache.
ResponseCacheDetails.Type Type of the Response Cache.
ResponseCacheLookupPolicy Base policy for Response Cache lookup.
ResponseCacheLookupPolicy.Type Type of the Response Cache Store Policy.
ResponseCacheRespServer Details of a RESP based cache store server Note: Objects should always be created or deserialized using the ResponseCacheRespServer.Builder.
ResponseCacheRespServer.Builder
ResponseCacheStorePolicy Base policy for how a response from a backend is cached in the Response Cache.
ResponseCacheStorePolicy.Type Type of the Response Cache Store Policy.
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.
Sdk Information about the SDK.
Sdk.Builder
Sdk.LifecycleState The current state of the SDK.
SdkCollection Collection of the existing SDKs.
SdkCollection.Builder
SdkLanguageOptionalParameters List of additional applicable parameters for any given target language.
SdkLanguageOptionalParameters.Builder
SdkLanguageOptionalParameters.InputType The input type for this param.
SdkLanguageOptionalParametersAllowedValue Allowed value object.
SdkLanguageOptionalParametersAllowedValue.Builder
SdkLanguageTypeCollection Collection of available SDK target languages.
SdkLanguageTypeCollection.Builder
SdkLanguageTypes SDK target language details.
SdkLanguageTypes.Builder
SdkLanguageTypeSummary SDK target language details.
SdkLanguageTypeSummary.Builder
SdkSummary A summary of the SDK.
SdkSummary.Builder
SelectionSourcePolicy The type of selector to use when dynamically routing and dynamically authenticating requests.
SelectionSourcePolicy.Type Type of the Selection source to use.
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.
SimpleLookupPolicy Provides ability to vary the cache key using context expressions.
SimpleLookupPolicy.Builder
SingleSelectionSourcePolicy The single context variable in an incoming request to match against specified selection keys when dynamically routing and dynamically authenticating requests.
SingleSelectionSourcePolicy.Builder
SourceUriDetails Auth endpoint details.
SourceUriDetails.Type Type of the Uri detail.
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
Subscriber A subscriber, which encapsulates a number of clients and usage plans that they are subscribed to.
Subscriber.Builder
Subscriber.LifecycleState The current state of the subscriber.
SubscriberCollection Collection of subscriber summaries.
SubscriberCollection.Builder
SubscriberSummary A summary of a subscriber.
SubscriberSummary.Builder
TokenAuthenticationPolicy Validate a token present in the header or query parameter.
TokenAuthenticationPolicy.Builder
TokenAuthenticationRemoteDiscoveryValidationPolicy Instrospect Url based validation retrieved at run-time from a remote location to verify the provided token.
TokenAuthenticationRemoteDiscoveryValidationPolicy.Builder
TokenAuthenticationRemoteJWKSValidationPolicy A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature.
TokenAuthenticationRemoteJWKSValidationPolicy.Builder
TokenAuthenticationStaticKeysValidationPolicy A set of static public keys that will be used to verify the JWT signature.
TokenAuthenticationStaticKeysValidationPolicy.Builder
TokenAuthenticationValidationPolicy Authentication Policies for the Token Authentication types.
TokenAuthenticationValidationPolicy.Type Type of the token validation policy.
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
UpdateSdkDetails The information to be updated.
UpdateSdkDetails.Builder
UpdateSubscriberDetails The information to be updated.
UpdateSubscriberDetails.Builder
UpdateUsagePlanDetails The information to be updated.
UpdateUsagePlanDetails.Builder
UsagePlan A usage plan controls access of subscribers to deployments, controlling rate limits and quotas for usage.
UsagePlan.Builder
UsagePlan.LifecycleState The current state of the usage plan.
UsagePlanCollection Collection of usage plan summaries.
UsagePlanCollection.Builder
UsagePlansPolicy Usage plan policies for this deployment Note: Objects should always be created or deserialized using the UsagePlansPolicy.Builder.
UsagePlansPolicy.Builder
UsagePlanSummary A summary of the usage plan.
UsagePlanSummary.Builder
ValidationBlockClientAppDetails Client App Credentials to be used from validation block.
ValidationBlockClientAppDetails.Builder
ValidationBlockSourceUriDetails Source Uri information to be used from validation block.
ValidationBlockSourceUriDetails.Builder
ValidationFailurePolicy Policy for defining behaviour on validation failure.
ValidationFailurePolicy.Type Type of the Validation failure Policy.
ValidationRequestPolicy Top-level validation policy mixin (not directly used).
ValidationRequestPolicy.Builder
ValidationRequestPolicy.ValidationMode Validation behavior mode.
WildcardSelectionKey When dynamically routing and dynamically authenticating requests, the route or authentication server associated with a selection key containing a wildcard is used if the context variable in an incoming request matches that key.
WildcardSelectionKey.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.
ChangeSubscriberCompartmentDetails The new compartment details for the subscriber.
ChangeUsagePlanCompartmentDetails The new compartment details for the usage plan.
CreateApiDetails Information about the new API.
CreateCertificateDetails Information about a new certificate.
CreateDeploymentDetails Information about a new deployment.
CreateGatewayDetails Information about the new gateway.
CreateSdkDetails Information about the new SDK.
CreateSubscriberDetails Information about a new subscriber.
CreateUsagePlanDetails Information about a new usage plan.
Deployment.LifecycleState The current state of the deployment.
Gateway.LifecycleState The current state of the gateway.
Sdk.LifecycleState The current state of the SDK.
Subscriber.LifecycleState The current state of the subscriber.
UpdateApiDetails The information to be updated.
UpdateCertificateDetails The information to be updated.
UpdateDeploymentDetails The information to be updated.
UpdateGatewayDetails The information to be updated.
UpdateSdkDetails The information to be updated.
UpdateSubscriberDetails The information to be updated.
UpdateUsagePlanDetails The information to be updated.
UsagePlan.LifecycleState The current state of the usage plan.

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.
Sdk Information about the SDK.
SdkCollection Collection of the existing SDKs.
SdkLanguageTypeCollection Collection of available SDK target languages.
Subscriber A subscriber, which encapsulates a number of clients and usage plans that they are subscribed to.
SubscriberCollection Collection of subscriber summaries.
UsagePlan A usage plan controls access of subscribers to deployments, controlling rate limits and quotas for usage.
UsagePlanCollection Collection of usage plan 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.