Package com.oracle.bmc.apigateway.model

Class Summary

Class	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
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
ApiSpecificationRouteBackend	The backend to forward requests to.
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
ApiValidationDetail	Detail of a single error or warning.
ApiValidationDetail.Builder
ApiValidationDetails	Detail of an error or warning.
ApiValidationDetails.Builder
ApiValidationResult	The result of single validation.
ApiValidationResult.Builder
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.
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
CaBundle	Reference to the CA bundle that should be used on the gateway Note: Objects should always be created or deserialized using the Builder.
Certificate	A certificate contains information to be installed on a gateway to secure the traffic going through it.
Certificate.Builder
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.
ClientSummary	A summary of a client.
ClientSummary.Builder
ContentValidation	Content validation properties.
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
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.
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
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
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
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
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
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
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
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.
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
Quota	Quota policy for a usage plan.
Quota.Builder
RateLimit	Rate-limiting policy for a usage plan.
RateLimit.Builder
RateLimitingPolicy	Limit the number of requests that should be handled for the specified window using a specfic key.
RateLimitingPolicy.Builder
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.
ResponseCacheLookupPolicy	Base policy for Response Cache lookup.
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.
RouteAuthorizationPolicy	If authentication has been performed, validate whether the request scope (if any) applies to this route.
Sdk	Information about the SDK.
Sdk.Builder
SdkCollection	Collection of the existing SDKs.
SdkCollection.Builder
SdkLanguageOptionalParameters	List of additional applicable parameters for any given target language.
SdkLanguageOptionalParameters.Builder
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.
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
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
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.
StaticPublicKey	A static public key which is used to verify the JWT signature.
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
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.
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
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.
ValidationRequestPolicy	Top-level validation policy mixin (not directly used).
ValidationRequestPolicy.Builder
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
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.Builder
WorkRequestSummary	A summary of the work request.
WorkRequestSummary.Builder

Enum Summary

Enum	Description
Api.LifecycleState	The current state of the API.
ApiSpecificationRoute.Methods
ApiSpecificationRouteBackend.Type	Type of the API backend.
ApiSummary.LifecycleState	The current state of the API.
ApiValidationDetail.Severity	Severity of the issue.
ApiValidationDetails.Result	Result of the validation.
ApiValidationResult.Result	Result of the validation.
AuthenticationPolicy.Type	Type of the authentication policy to use.
BodyValidationRequestPolicy.ValidationMode	Validation behavior mode.
CaBundle.Type	Type of the CA bundle
Certificate.LifecycleState	The current state of the certificate.
ClientAppDetails.Type	To specify where the Client App details should be taken from.
ContentValidation.ValidationType	Validation type defines the content validation method.
Deployment.LifecycleState	The current state of the deployment.
DynamicSelectionKey.Type	Type of the selection key.
ExecutionLogPolicy.LogLevel	Specifies the log level used to control logging output of execution logs.
FilterHeaderPolicy.Type	BLOCK drops any headers that are in the list of items, so it acts as an exclusion list.
FilterQueryParameterPolicy.Type	BLOCK drops any query parameters that are in the list of items, so it acts as an exclusion list.
Gateway.EndpointType	Gateway endpoint type.
Gateway.LifecycleState	The current state of the gateway.
HeaderValidationRequestPolicy.ValidationMode	Validation behavior mode.
JsonWebKey.KeyOps
JsonWebKey.Kty	The key type.
JsonWebKey.Use	The intended use of the public key.
OAuth2ResponseValidationFailurePolicy.ResponseType	Response Type.
PublicKeySet.Type	Type of the public key set.
QueryParameterValidationRequestPolicy.ValidationMode	Validation behavior mode.
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.Unit	The unit of time over which rate limits are calculated.
RateLimitingPolicy.RateKey	The key used to group requests together.
ResponseCacheDetails.Type	Type of the Response Cache.
ResponseCacheLookupPolicy.Type	Type of the Response Cache Store Policy.
ResponseCacheStorePolicy.Type	Type of the Response Cache Store Policy.
RouteAuthorizationPolicy.Type	Indicates how authorization should be applied.
Sdk.LifecycleState	The current state of the SDK.
SdkLanguageOptionalParameters.InputType	The input type for this param.
SelectionSourcePolicy.Type	Type of the Selection source to use.
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.
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.
SourceUriDetails.Type	Type of the Uri detail.
StaticPublicKey.Format	The format of the public key.
Subscriber.LifecycleState	The current state of the subscriber.
TokenAuthenticationValidationPolicy.Type	Type of the token validation policy.
UsagePlan.LifecycleState	The current state of the usage plan.
ValidationFailurePolicy.Type	Type of the Validation failure Policy.
ValidationRequestPolicy.ValidationMode	Validation behavior mode.
WorkRequest.OperationType	The type of the work request.
WorkRequest.Status	The status of the work request.
WorkRequestResource.ActionType	The way in which this resource is affected by the work tracked in the work request.