Namespace Oci.LoadbalancerService.Models
Classes
Action
An entity that represents an action to apply for a routing rule.
ActionModelConverter
AddHttpRequestHeaderRule
An object that represents the action of adding a header to a request.
This rule applies only to HTTP listeners.
NOTES:
- If a matching header already exists in the request, the system removes all of its occurrences, and then adds the
new header.
- The system does not distinquish between underscore and dash characters in headers. That is, it treats
example_header_name
andexample-header-name
as identical. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.
AddHttpResponseHeaderRule
An object that represents the action of adding a header to a response.
This rule applies only to HTTP listeners.
NOTES:
- If a matching header already exists in the response, the system removes all of its occurrences, and then adds the
new header.
- The system does not distinquish between underscore and dash characters in headers. That is, it treats
example_header_name
andexample-header-name
as identical. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.
AllowRule
An object that represents the action of configuring an access control rule. Access control rules permit access
to application resources based on user-specified match conditions. This rule applies only to HTTP listeners.
NOTES:
- If you do not specify any access control rules, the default rule is to allow all traffic.
- If you add access control rules, the load balancer denies any traffic that does not match the rules.
- Maximum of two match conditions can be specified in a rule.
- You can specify this rule only with the following
RuleCondition
combinations:SOURCE_IP_ADDRESS
SOURCE_VCN_ID
SOURCE_VCN_ID\", \"SOURCE_VCN_IP_ADDRESS
Backend
The configuration of a backend server that is a member of a load balancer backend set. For more information, see Managing Backend Servers.
BackendDetails
The load balancing configuration details of a backend server.
BackendHealth
The health status of the specified backend server as reported by the primary and standby load balancers.
BackendSet
The configuration of a load balancer backend set.
For more information on backend set configuration, see
Managing Backend Sets.
Note: The sessionPersistenceConfiguration
(application cookie stickiness) and lbCookieSessionPersistenceConfiguration
(LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two
attributes per backend set.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
BackendSetDetails
The configuration details for a load balancer backend set.
For more information on backend set configuration, see
Managing Backend Sets.
Note: The sessionPersistenceConfiguration
(application cookie stickiness) and lbCookieSessionPersistenceConfiguration
(LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two
attributes per backend set.
BackendSetHealth
The health status details for a backend set.
This object does not explicitly enumerate backend servers with a status of OK
. However, they are included in the
totalBackendCount
sum.
Certificate
The configuration details of a certificate bundle.
For more information on SSL certficate configuration, see
Managing SSL Certificates.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CertificateDetails
The configuration details for a certificate bundle.
For more information on SSL certficate configuration, see
Managing SSL Certificates.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
ChangeLoadBalancerCompartmentDetails
The configuration details for moving a load balancer to a different compartment.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
ConnectionConfiguration
Configuration details for the connection between the client and backend servers.
ControlAccessUsingHttpMethodsRule
An object that represents the action of returning a specified response code when the requested HTTP method is not in
the list of allowed methods for the listener. The load balancer does not forward a disallowed request to the back end
servers. The default response code is 405 Method Not Allowed
.
If you set the response code to 405
or leave it blank, the system adds an "allow" response header that contains a
list of the allowed methods for the listener. If you set the response code to anything other than 405
(or blank),
the system does not add the "allow" response header with a list of allowed methods.
This rule applies only to HTTP listeners. No more than one ControlAccessUsingHttpMethodsRule
object can be present in
a given listener.
CreateBackendDetails
The configuration details for creating a backend server in a backend set. For more information on backend server configuration, see Managing Backend Servers.
CreateBackendSetDetails
The configuration details for creating a backend set in a load balancer.
For more information on backend set configuration, see
Managing Backend Sets.
Note: The sessionPersistenceConfiguration
(application cookie stickiness) and lbCookieSessionPersistenceConfiguration
(LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two
attributes per backend set.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateCertificateDetails
The configuration details for adding a certificate bundle to a listener.
For more information on SSL certficate configuration, see
Managing SSL Certificates.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateHostnameDetails
The details of the hostname resource to add to a load balancer.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateListenerDetails
The configuration details for adding a listener to a backend set.
For more information on listener configuration, see
Managing Load Balancer Listeners.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateLoadBalancerDetails
The configuration details for creating a load balancer.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreatePathRouteSetDetails
A named set of path route rules to add to the load balancer.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateRoutingPolicyDetails
An ordered list of routing rules.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateRuleSetDetails
A named set of rules to add to the load balancer.
CreateSSLCipherSuiteDetails
The configuration details of an SSL cipher suite.
The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer
(SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to
negotiate with peers while sending and receiving information. The cipher suites you use affect the security
level, performance, and compatibility of your data traffic.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Oracle created the following predefined cipher suites that you can specify when you define a resource's
SSL configuration. You can create custom
cipher suites if the predefined cipher
suites do not meet your requirements.
- oci-default-ssl-cipher-suite-v1
"DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" - oci-modern-ssl-cipher-suite-v1
"AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" - oci-compatible-ssl-cipher-suite-v1
"AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" - oci-wider-compatible-ssl-cipher-suite-v1
"AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "CAMELLIA128-SHA" "CAMELLIA256-SHA" "DES-CBC3-SHA" "DH-DSS-AES128-GCM-SHA256" "DH-DSS-AES128-SHA" "DH-DSS-AES128-SHA256" "DH-DSS-AES256-GCM-SHA384" "DH-DSS-AES256-SHA" "DH-DSS-AES256-SHA256" "DH-DSS-CAMELLIA128-SHA" "DH-DSS-CAMELLIA256-SHA" "DH-DSS-DES-CBC3-SHAv" "DH-DSS-SEED-SHA" "DH-RSA-AES128-GCM-SHA256" "DH-RSA-AES128-SHA" "DH-RSA-AES128-SHA256" "DH-RSA-AES256-GCM-SHA384" "DH-RSA-AES256-SHA" "DH-RSA-AES256-SHA256" "DH-RSA-CAMELLIA128-SHA" "DH-RSA-CAMELLIA256-SHA" "DH-RSA-DES-CBC3-SHA" "DH-RSA-SEED-SHA" "DHE-DSS-AES128-GCM-SHA256" "DHE-DSS-AES128-SHA" "DHE-DSS-AES128-SHA256" "DHE-DSS-AES256-GCM-SHA384" "DHE-DSS-AES256-SHA" "DHE-DSS-AES256-SHA256" "DHE-DSS-CAMELLIA128-SHA" "DHE-DSS-CAMELLIA256-SHA" "DHE-DSS-DES-CBC3-SHA" "DHE-DSS-SEED-SHA" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA" "DHE-RSA-AES256-SHA256" "DHE-RSA-CAMELLIA128-SHA" "DHE-RSA-CAMELLIA256-SHA" "DHE-RSA-DES-CBC3-SHA" "DHE-RSA-SEED-SHA" "ECDH-ECDSA-AES128-GCM-SHA256" "ECDH-ECDSA-AES128-SHA" "ECDH-ECDSA-AES128-SHA256" "ECDH-ECDSA-AES256-GCM-SHA384" "ECDH-ECDSA-AES256-SHA" "ECDH-ECDSA-AES256-SHA384" "ECDH-ECDSA-DES-CBC3-SHA" "ECDH-ECDSA-RC4-SHA" "ECDH-RSA-AES128-GCM-SHA256" "ECDH-RSA-AES128-SHA" "ECDH-RSA-AES128-SHA256" "ECDH-RSA-AES256-GCM-SHA384" "ECDH-RSA-AES256-SHA" "ECDH-RSA-AES256-SHA384" "ECDH-RSA-DES-CBC3-SHA" "ECDH-RSA-RC4-SHA" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-ECDSA-DES-CBC3-SHA" "ECDHE-ECDSA-RC4-SHA" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" "ECDHE-RSA-DES-CBC3-SHA" "ECDHE-RSA-RC4-SHA" "IDEA-CBC-SHA" "KRB5-DES-CBC3-MD5" "KRB5-DES-CBC3-SHA" "KRB5-IDEA-CBC-MD5" "KRB5-IDEA-CBC-SHA" "KRB5-RC4-MD5" "KRB5-RC4-SHA" "PSK-3DES-EDE-CBC-SHA" "PSK-AES128-CBC-SHA" "PSK-AES256-CBC-SHA" "PSK-RC4-SHA" "RC4-MD5" "RC4-SHA" "SEED-SHA" - oci-default-http2-ssl-cipher-suite-v1
"ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES128-GCM-SHA256" - oci-default-http2-tls-13-ssl-cipher-suite-v1
"TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" - oci-default-http2-tls-12-13-ssl-cipher-suite-v1
"ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES128-GCM-SHA256" "TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" - oci-tls-13-recommended-ssl-cipher-suite-v1
"TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" - oci-tls-12-13-wider-ssl-cipher-suite-v1
"TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES256-SHA384" "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" - oci-tls-11-12-13-wider-ssl-cipher-suite-v1 "TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES256-SHA384" "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA" "AES128-SHA" "AES256-SHA"
ExtendHttpRequestHeaderValueRule
An object that represents the action of modifying a request header value. This rule applies only to HTTP listeners.
This rule adds a prefix, a suffix, or both to the header value.
NOTES:
- This rule requires a value for a prefix, suffix, or both.
- The system does not support this rule for headers with multiple values.
- The system does not distinquish between underscore and dash characters in headers. That is, it treats
example_header_name
andexample-header-name
as identical. If two such headers appear in a request, the system applies the action to the first header it finds. The affected header cannot be determined in advance. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.
ExtendHttpResponseHeaderValueRule
An object that represents the action of modifying a response header value. This rule applies only to HTTP listeners.
This rule adds a prefix, a suffix, or both to the header value.
NOTES:
- This rule requires a value for a prefix, suffix, or both.
- The system does not support this rule for headers with multiple values.
- The system does not distinquish between underscore and dash characters in headers. That is, it treats
example_header_name
andexample-header-name
as identical. If two such headers appear in a request, the system applies the action to the first header it finds. The affected header cannot be determined in advance. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.
ForwardToBackendSet
Action to forward requests to a given backend set.
HealthCheckResult
Information about a single backend server health check result reported by a load balancer.
HealthChecker
The health check policy configuration. For more information, see Editing Health Check Policies.
HealthCheckerDetails
The health check policy's configuration details.
Hostname
A hostname resource associated with a load balancer for use by one or more listeners.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
HostnameDetails
The details of a hostname resource associated with a load balancer.
HttpHeaderRule
An object that represents the advance http header options that allow the setting of http header size and allow/disallow
invalid characters in the http headers.
For example httpLargeHeaderSizeInKB=32, the http header could have 4 buffers of 32KBs each
This rule applies only to HTTP listeners. No more than one HttpHeaderRule
object can be present in
a given listener.
IpAddress
A load balancer IP address.
IpBasedMaxConnectionsRule
An object that represents the action of configuring an IP max connection rule which specifies how many connections IPs can make to a listener.
IpMaxConnections
An object that species the maximum number of connections the listed IPs can make to a listener.
LBCookieSessionPersistenceConfigurationDetails
The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
Session persistence enables the Load Balancing service to direct all requests that originate from a single logical
client to a single backend web server. For more information, see
Session Persistence.
When you configure LB cookie stickiness, the load balancer inserts a cookie into the response. The parameters configured
in the cookie enable session stickiness. This method is useful when you have applications and Web backend services
that cannot generate their own cookies.
Path route rules take precedence to determine the target backend server. The load balancer verifies that session stickiness
is enabled for the backend server and that the cookie configuration (domain, path, and cookie hash) is valid for the
target. The system ignores invalid cookies.
To disable LB cookie stickiness on a running load balancer, use the
{@link #updateBackendSet(UpdateBackendSetRequest) updateBackendSet} operation and specify null
for the
LBCookieSessionPersistenceConfigurationDetails
object.
Example: LBCookieSessionPersistenceConfigurationDetails: nullNote: SessionPersistenceConfigurationDetails (application cookie stickiness) and LBCookieSessionPersistenceConfigurationDetails(LB cookie stickiness) are mutually exclusive. An error results if you try to enable both types of session persistence.Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Listener
The listener's configuration. For more information on backend set configuration, see Managing Load Balancer Listeners.
ListenerDetails
The listener's configuration details.
ListenerRuleSummary
The attributes of a rule associated with the specified listener, and the name of the rule set that the rule belongs to.
LoadBalancer
The properties that define a load balancer. For more information, see
Managing a Load Balancer.
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.
For information about endpoints and signing API requests, see
About the API. For information about available SDKs and tools, see
SDKS and Other Tools.
LoadBalancerHealth
The health status details for the specified load balancer.
This object does not explicitly enumerate backend sets with a status of OK
. However, they are included in the
totalBackendSetCount
sum.
LoadBalancerHealthSummary
A health status summary for the specified load balancer.
LoadBalancerPolicy
A policy that determines how traffic is distributed among backend servers. For more information on load balancing policies, see How Load Balancing Policies Work.
LoadBalancerProtocol
A protocol that defines the type of traffic accepted by a listener.
LoadBalancerShape
A shape is a template that determines the total pre-provisioned bandwidth (ingress plus egress) for the
load balancer.
Note that the pre-provisioned maximum capacity applies to aggregated connections, not to a single client
attempting to use the full bandwidth.
PathMatchCondition
The path string and match condition to apply when evaluating an incoming URI for redirection.
PathMatchType
The type of matching to apply to incoming URIs.
PathRoute
A "path route rule" to evaluate an incoming URI path, and then route a matching request to the specified backend set.
Path route rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.
PathRouteSet
A named set of path route rules. For more information, see
Managing Request Routing.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
PathRouteSetDetails
A set of path route rules.
RedirectRule
An object that represents the action of returning a specified response code and a redirect URI. Each RedirectRule
object is configured for a particular listener and a designated path.
The default response code is 302 Found
.
NOTES:
- This rule applies only to HTTP listeners.
- You can specify this rule only with the {@link #ruleCondition(RuleConditionRequest) ruleCondition}
type
PATH
. - A listener can have only one RedirectRule object for a given original path. The
{@link #pathMatchCondition(PathMatchConditionRequest) pathMatchCondition}
attributeValue
specifies the original path.
RedirectUri
An object that defines the redirect URI applied to the original request. The object property values compose the
redirect URI.
NOTE: The Load Balancing service cannot automatically detect or avoid infinite redirects. Be sure to provide
meaningful, complete, and correct field values. If any component field of this object has no value, the system
retains the value from the incoming HTTP request URI.
For example, if you specify only the protocol field https
, and the incoming request URI is
http://example.com:8080
, the resulting runtime redirect URI is https://example.com:8080
. The system retains
the host and port from the incoming URI and does not automatically change the port setting from 8080
to 443
.
Be sure to configure valid percent-encoding (URL encoding) when needed.
In addition to static string values, you can use the following tokens to construct the redirect URI. These tokens
extract values from the incoming HTTP request URI.
- {protocol} : The protocol from the incoming HTTP request URI.
- {host} : The domain name from the incoming HTTP request URI.
- {port} : The port from the incoming HTTP request URI.
- {path} : The path from the incoming HTTP request URI.
- {query} : The query string from the incoming HTTP request URI.
The tokens are case sensitive. For example,{host}
is a valid token, but{HOST}
is not.
You can retain the literal characters of a token when you specify values for the path and query properties of the redirect URI. Use a backslash (\\) as the escape character for the \\, {, and } characters. For example, if the incoming HTTP request URI is/video
, the path property value:
/example{path}123\\{path\\}
appears in the constructed redirect URI as:
/example/video123{path}
RemoveHttpRequestHeaderRule
An object that represents the action of removing a header from a request. This rule applies only to HTTP listeners.
If the same header appears more than once in the request, the load balancer removes all occurances of the specified header.
Note: The system does not distinquish between underscore and dash characters in headers. That is, it treats
example_header_name
and example-header-name
as identical. Oracle recommends that you do not rely on underscore
or dash characters to uniquely distinguish header names.
RemoveHttpResponseHeaderRule
An object that represents the action of removing a header from a response. This rule applies only to HTTP listeners.
If the same header appears more than once in the response, the load balancer removes all occurances of the specified header.
Note: The system does not distinquish between underscore and dash characters in headers. That is, it treats
example_header_name
and example-header-name
as identical. Oracle recommends that you do not rely on underscore
or dash characters to uniquely distinguish header names.
ReservedIP
RoutingPolicy
A named ordered list of routing rules that is applied to a listener.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
RoutingPolicyDetails
An ordered list of routing rules. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
RoutingRule
A routing rule examines an incoming request, routing matching requests to the specified backend set. Routing rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.
Rule
An object that represents an action to apply to a listener.
RuleCondition
A condition to apply to an access control rule.
RuleConditionModelConverter
RuleModelConverter
RuleSet
A named set of rules associated with a load balancer. Rules are objects that represent actions to apply to a listener, such as adding, altering, or removing HTTP headers. For more information, see Managing Rule Sets.
RuleSetDetails
The rules that compose a rule set.
SSLCipherSuite
The configuration details of an SSL cipher suite.
The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer
(SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to
negotiate with peers while sending and receiving information. The cipher suites you use affect the security
level, performance, and compatibility of your data traffic.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Oracle created the following predefined cipher suites that you can specify when you define a resource's
SSL configuration. You can create custom
cipher suites if the predefined cipher
suites do not meet your requirements.
- oci-default-ssl-cipher-suite-v1
"DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" - oci-modern-ssl-cipher-suite-v1
"AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" - oci-compatible-ssl-cipher-suite-v1
"AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" - oci-wider-compatible-ssl-cipher-suite-v1
"AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "CAMELLIA128-SHA" "CAMELLIA256-SHA" "DES-CBC3-SHA" "DH-DSS-AES128-GCM-SHA256" "DH-DSS-AES128-SHA" "DH-DSS-AES128-SHA256" "DH-DSS-AES256-GCM-SHA384" "DH-DSS-AES256-SHA" "DH-DSS-AES256-SHA256" "DH-DSS-CAMELLIA128-SHA" "DH-DSS-CAMELLIA256-SHA" "DH-DSS-DES-CBC3-SHAv" "DH-DSS-SEED-SHA" "DH-RSA-AES128-GCM-SHA256" "DH-RSA-AES128-SHA" "DH-RSA-AES128-SHA256" "DH-RSA-AES256-GCM-SHA384" "DH-RSA-AES256-SHA" "DH-RSA-AES256-SHA256" "DH-RSA-CAMELLIA128-SHA" "DH-RSA-CAMELLIA256-SHA" "DH-RSA-DES-CBC3-SHA" "DH-RSA-SEED-SHA" "DHE-DSS-AES128-GCM-SHA256" "DHE-DSS-AES128-SHA" "DHE-DSS-AES128-SHA256" "DHE-DSS-AES256-GCM-SHA384" "DHE-DSS-AES256-SHA" "DHE-DSS-AES256-SHA256" "DHE-DSS-CAMELLIA128-SHA" "DHE-DSS-CAMELLIA256-SHA" "DHE-DSS-DES-CBC3-SHA" "DHE-DSS-SEED-SHA" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA" "DHE-RSA-AES256-SHA256" "DHE-RSA-CAMELLIA128-SHA" "DHE-RSA-CAMELLIA256-SHA" "DHE-RSA-DES-CBC3-SHA" "DHE-RSA-SEED-SHA" "ECDH-ECDSA-AES128-GCM-SHA256" "ECDH-ECDSA-AES128-SHA" "ECDH-ECDSA-AES128-SHA256" "ECDH-ECDSA-AES256-GCM-SHA384" "ECDH-ECDSA-AES256-SHA" "ECDH-ECDSA-AES256-SHA384" "ECDH-ECDSA-DES-CBC3-SHA" "ECDH-ECDSA-RC4-SHA" "ECDH-RSA-AES128-GCM-SHA256" "ECDH-RSA-AES128-SHA" "ECDH-RSA-AES128-SHA256" "ECDH-RSA-AES256-GCM-SHA384" "ECDH-RSA-AES256-SHA" "ECDH-RSA-AES256-SHA384" "ECDH-RSA-DES-CBC3-SHA" "ECDH-RSA-RC4-SHA" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-ECDSA-DES-CBC3-SHA" "ECDHE-ECDSA-RC4-SHA" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" "ECDHE-RSA-DES-CBC3-SHA" "ECDHE-RSA-RC4-SHA" "IDEA-CBC-SHA" "KRB5-DES-CBC3-MD5" "KRB5-DES-CBC3-SHA" "KRB5-IDEA-CBC-MD5" "KRB5-IDEA-CBC-SHA" "KRB5-RC4-MD5" "KRB5-RC4-SHA" "PSK-3DES-EDE-CBC-SHA" "PSK-AES128-CBC-SHA" "PSK-AES256-CBC-SHA" "PSK-RC4-SHA" "RC4-MD5" "RC4-SHA" "SEED-SHA" - oci-default-http2-ssl-cipher-suite-v1
"ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES128-GCM-SHA256" - oci-default-http2-tls-13-ssl-cipher-suite-v1
"TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" - oci-default-http2-tls-12-13-ssl-cipher-suite-v1
"ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES128-GCM-SHA256" "TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" - oci-tls-13-recommended-ssl-cipher-suite-v1
"TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" - oci-tls-12-13-wider-ssl-cipher-suite-v1
"TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES256-SHA384" "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" - oci-tls-11-12-13-wider-ssl-cipher-suite-v1 "TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES256-SHA384" "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA" "AES128-SHA" "AES256-SHA"
SSLCipherSuiteDetails
The configuration details of an SSL cipher suite.
The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer
(SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to
negotiate with peers while sending and receiving information. The cipher suites you use affect the security
level, performance, and compatibility of your data traffic.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Oracle created the following predefined cipher suites that you can specify when you define a resource's
SSL configuration. You can create custom
cipher suites if the predefined cipher
suites do not meet your requirements.
- oci-default-ssl-cipher-suite-v1
"DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" - oci-modern-ssl-cipher-suite-v1
"AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" - oci-compatible-ssl-cipher-suite-v1
"AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" - oci-wider-compatible-ssl-cipher-suite-v1
"AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "CAMELLIA128-SHA" "CAMELLIA256-SHA" "DES-CBC3-SHA" "DH-DSS-AES128-GCM-SHA256" "DH-DSS-AES128-SHA" "DH-DSS-AES128-SHA256" "DH-DSS-AES256-GCM-SHA384" "DH-DSS-AES256-SHA" "DH-DSS-AES256-SHA256" "DH-DSS-CAMELLIA128-SHA" "DH-DSS-CAMELLIA256-SHA" "DH-DSS-DES-CBC3-SHAv" "DH-DSS-SEED-SHA" "DH-RSA-AES128-GCM-SHA256" "DH-RSA-AES128-SHA" "DH-RSA-AES128-SHA256" "DH-RSA-AES256-GCM-SHA384" "DH-RSA-AES256-SHA" "DH-RSA-AES256-SHA256" "DH-RSA-CAMELLIA128-SHA" "DH-RSA-CAMELLIA256-SHA" "DH-RSA-DES-CBC3-SHA" "DH-RSA-SEED-SHA" "DHE-DSS-AES128-GCM-SHA256" "DHE-DSS-AES128-SHA" "DHE-DSS-AES128-SHA256" "DHE-DSS-AES256-GCM-SHA384" "DHE-DSS-AES256-SHA" "DHE-DSS-AES256-SHA256" "DHE-DSS-CAMELLIA128-SHA" "DHE-DSS-CAMELLIA256-SHA" "DHE-DSS-DES-CBC3-SHA" "DHE-DSS-SEED-SHA" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA" "DHE-RSA-AES256-SHA256" "DHE-RSA-CAMELLIA128-SHA" "DHE-RSA-CAMELLIA256-SHA" "DHE-RSA-DES-CBC3-SHA" "DHE-RSA-SEED-SHA" "ECDH-ECDSA-AES128-GCM-SHA256" "ECDH-ECDSA-AES128-SHA" "ECDH-ECDSA-AES128-SHA256" "ECDH-ECDSA-AES256-GCM-SHA384" "ECDH-ECDSA-AES256-SHA" "ECDH-ECDSA-AES256-SHA384" "ECDH-ECDSA-DES-CBC3-SHA" "ECDH-ECDSA-RC4-SHA" "ECDH-RSA-AES128-GCM-SHA256" "ECDH-RSA-AES128-SHA" "ECDH-RSA-AES128-SHA256" "ECDH-RSA-AES256-GCM-SHA384" "ECDH-RSA-AES256-SHA" "ECDH-RSA-AES256-SHA384" "ECDH-RSA-DES-CBC3-SHA" "ECDH-RSA-RC4-SHA" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-ECDSA-DES-CBC3-SHA" "ECDHE-ECDSA-RC4-SHA" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" "ECDHE-RSA-DES-CBC3-SHA" "ECDHE-RSA-RC4-SHA" "IDEA-CBC-SHA" "KRB5-DES-CBC3-MD5" "KRB5-DES-CBC3-SHA" "KRB5-IDEA-CBC-MD5" "KRB5-IDEA-CBC-SHA" "KRB5-RC4-MD5" "KRB5-RC4-SHA" "PSK-3DES-EDE-CBC-SHA" "PSK-AES128-CBC-SHA" "PSK-AES256-CBC-SHA" "PSK-RC4-SHA" "RC4-MD5" "RC4-SHA" "SEED-SHA" - oci-default-http2-ssl-cipher-suite-v1
"ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES128-GCM-SHA256" - oci-default-http2-tls-13-ssl-cipher-suite-v1
"TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" - oci-default-http2-tls-12-13-ssl-cipher-suite-v1
"ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES128-GCM-SHA256" "TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" - oci-tls-13-recommended-ssl-cipher-suite-v1
"TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" - oci-tls-12-13-wider-ssl-cipher-suite-v1
"TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES256-SHA384" "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" - oci-tls-11-12-13-wider-ssl-cipher-suite-v1 "TLS_AES_128_GCM_SHA256" "TLS_AES_256_GCM_SHA384" "TLS_CHACHA20_POLY1305_SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES256-SHA384" "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA" "AES128-SHA" "AES256-SHA"
SSLConfiguration
A listener's SSL handling configuration.
To use SSL, a listener must be associated with a {@link Certificate}.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
SSLConfigurationDetails
The load balancer's SSL handling configuration details.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
SessionPersistenceConfigurationDetails
The configuration details for implementing session persistence based on a user-specified cookie name (application
cookie stickiness).
Session persistence enables the Load Balancing service to direct any number of requests that originate from a single
logical client to a single backend web server. For more information, see
Session Persistence.
With application cookie stickiness, the load balancer enables session persistence only when the response from a backend
application server includes a Set-cookie
header with the user-specified cookie name.
To disable application cookie stickiness on a running load balancer, use the
{@link #updateBackendSet(UpdateBackendSetRequest) updateBackendSet} operation and specify null
for the
SessionPersistenceConfigurationDetails
object.
Example: SessionPersistenceConfigurationDetails: nullNote: SessionPersistenceConfigurationDetails (application cookie stickiness) and LBCookieSessionPersistenceConfigurationDetails(LB cookie stickiness) are mutually exclusive. An error results if you try to enable both types of session persistence.Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
ShapeDetails
The configuration details to update load balancer to a different shape.
SourceIpAddressCondition
A rule condition that checks client source IP against specified IP address or address range.
SourceVcnIdCondition
An access control rule condition that requires a match on the specified source VCN OCID.
SourceVcnIpAddressCondition
An access control rule condition that requires a match on the specified source VCN and IP address range.
This condition must be used only in conjunction with SourceVcnIdCondition
.
UpdateBackendDetails
The configuration details for updating a backend server.
UpdateBackendSetDetails
The configuration details for updating a load balancer backend set.
For more information on backend set configuration, see
Managing Backend Sets.
Note: The sessionPersistenceConfiguration
(application cookie stickiness) and lbCookieSessionPersistenceConfiguration
(LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two
attributes per backend set.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
UpdateHealthCheckerDetails
The health checker's configuration details.
UpdateHostnameDetails
The configuration details for updating a virtual hostname. For more information on virtual hostnames, see Managing Request Routing.
UpdateListenerDetails
The configuration details for updating a listener.
UpdateLoadBalancerDetails
Configuration details to update a load balancer.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
UpdateLoadBalancerShapeDetails
UpdateNetworkSecurityGroupsDetails
An object representing an updated list of network security groups (NSGs) that overwrites the existing list of NSGs.
- If the load balancer has no NSGs configured, it uses the NSGs in this list.
- If the load balancer has a list of NSGs configured, this list replaces the existing list.
- If the load balancer has a list of NSGs configured and this list is empty, the operation removes all of the load balancer's NSG associations.
UpdatePathRouteSetDetails
An updated set of path route rules that overwrites the existing set of rules.
UpdateRoutingPolicyDetails
An updated list of routing rules that overwrites the existing list of routing rules.
UpdateRuleSetDetails
An updated set of rules that overwrites the existing set of rules.
UpdateSSLCipherSuiteDetails
The configuration details for updating an SSL cipher suite.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
WorkRequest
Many of the API requests you use to create and configure load balancing do not take effect immediately. In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest objects provide visibility for in-progress work flows. For more information about work requests, see Viewing the State of a Work Request.
WorkRequestError
An object returned in the event of a work request error.