# README

Oracle Cloud Infrastructure Load Balancer Classic Client

Client implementation for the REST API for Oracle Cloud Infrastructure Load Balancing Classic

The LBaaSClient is the base client implementation for the Load Balancer Classic APIs, but is not intended to be use directly. Specialized clients are implemented for different LBaaS Service resources:

  • LBaaSClient - base implementation
    • SSLCertificateClient - for SSL Certificates
    • LoadBalancerClient - for the main Load Balancer resource
    • LBaaSResourceClient - base client implementation for child resources of a Load Balancer instance:
      • PolicyClient - for Policies
      • ListenerClient - for Listeners
      • OriginServerPoolClient - for Origin Server Pools

Testing

Setup the testing environment according as covered in Running the SDK Integration Tests

To run all the Load Balancer Classic client acceptance tests

$ make testacc TEST="./lbaas"

To run a single test

$ make testacc TEST="./lbaas" TESTARG="-run=TestAccLoadBalancerLifeCycle"

Settings the Test Region

The Load Balancer resources are created in a specific region. The default region used by the tests is uscom-central-1. To use a different region set the environment variable OCP_TEST_LBAAS_REGION e.g.

$ OPC_TEST_LBAAS_REGION=uscom-east-1  make testacc TEST="./lbaas"

Speeding up testing during development

The full Lifecycle tests of the Listener, Origin Server Pool and Policy resources each create a separate parent Load Balance instance. As the creation and destruction of the Load Balancer can take time a shortcut for development testing is provided:

To speed up testing of the Load Balancer child resources set the environment variable OPC_TEST_USE_EXISTING_LB to the ID of an existing Load Balancer instance in the format <region>/<name>, e.g.

$ OPC_TEST_USE_EXISTING_LB=uscom-central-1/lb1 make test acc TEST="./lbaas" TESTARG="-run=TestAccListenerLifeCycle"

# Functions

GetTestClient obtains a client for testing purposes.
NewClient returns a new LBaaSClient.

# Constants

Policy Specific ContentTypes for API REquests.
No description provided by the author
No description provided by the author
ContentType for Load Balancer Listener API requests.
No description provided by the author
ContentType for Load Balancer Origin Server Pool API requests.
No description provided by the author
No description provided by the author
No description provided by the author
Supported ContentTypes for the SSL Certificate API requests.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ContentType for Load Balancer API requests.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
Client implementation for Oracle Cloud Infrastructure Load Balancing Classic */.
No description provided by the author
No description provided by the author
No description provided by the author
CreateLoadBalancerInput specifies the create request for a load balancer service instance.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
LBaaSResourceClient is an AuthenticatedClient with some additional information about the resources to be addressed.
ListenerClient is a client for the Load Balancer Listener resources.
No description provided by the author
LoadBalancerClient is an AuthenticatedClient with some additional information about the resources to be addressed.
LoadBalancerContext represents a specific loadbalancer instance by region/name context.
No description provided by the author
LoadBalancerInfo specifies the Load Balancer obtained from a GET request.
No description provided by the author
No description provided by the author
OriginServerPoolClient is a client for the Load Balancer Origin Server Pool resources.
No description provided by the author
PolicyClient is a client for the Load Balancer Policy resources.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
use pointer for nilable fields on update.
No description provided by the author
No description provided by the author
use pointer for niable fields on update.
SSLCertificateClient is an AuthenticatedClient with some additional information about the resources to be addressed.
No description provided by the author
No description provided by the author
No description provided by the author
use pointer for attributes that can be unset.
UpdateLoadBalancerInput specifies the create request for a load balancer service instance using pointer for options items where empty string needs to be passed to clear if previously set.
use pointer for attributes that can be unset.
No description provided by the author
No description provided by the author

# Type aliases

HttpMethods.
LBaaSDisabled common Disabled State type for all LBaaS service resources.
LBaaSState common State type for all LBaaS service resources.
LBaaaSStatus common Status type for all LBaaS service resources.
LoadBalancerEffectiveState.
LoadBalancerScheme Scheme types.
No description provided by the author
No description provided by the author
Projections can be specified when retrieving collection of resources as well as when retrieving a specific resource.