oci-go-sdk: github.com/oracle/oci-go-sdk/loadbalancer Index | Files

package loadbalancer

import "github.com/oracle/oci-go-sdk/loadbalancer"

Index

Package Files

add_http_request_header_rule.go add_http_response_header_rule.go allow_rule.go backend.go backend_details.go backend_health.go backend_set.go backend_set_details.go backend_set_health.go certificate.go certificate_details.go change_load_balancer_compartment_details.go change_load_balancer_compartment_request_response.go connection_configuration.go control_access_using_http_methods_rule.go create_backend_details.go create_backend_request_response.go create_backend_set_details.go create_backend_set_request_response.go create_certificate_details.go create_certificate_request_response.go create_hostname_details.go create_hostname_request_response.go create_listener_details.go create_listener_request_response.go create_load_balancer_details.go create_load_balancer_request_response.go create_path_route_set_details.go create_path_route_set_request_response.go create_rule_set_details.go create_rule_set_request_response.go delete_backend_request_response.go delete_backend_set_request_response.go delete_certificate_request_response.go delete_hostname_request_response.go delete_listener_request_response.go delete_load_balancer_request_response.go delete_path_route_set_request_response.go delete_rule_set_request_response.go extend_http_request_header_value_rule.go extend_http_response_header_value_rule.go get_backend_health_request_response.go get_backend_request_response.go get_backend_set_health_request_response.go get_backend_set_request_response.go get_health_checker_request_response.go get_hostname_request_response.go get_load_balancer_health_request_response.go get_load_balancer_request_response.go get_path_route_set_request_response.go get_rule_set_request_response.go get_work_request_request_response.go health_check_result.go health_checker.go health_checker_details.go hostname.go hostname_details.go ip_address.go lb_cookie_session_persistence_configuration_details.go list_backend_sets_request_response.go list_backends_request_response.go list_certificates_request_response.go list_hostnames_request_response.go list_listener_rules_request_response.go list_load_balancer_healths_request_response.go list_load_balancers_request_response.go list_path_route_sets_request_response.go list_policies_request_response.go list_protocols_request_response.go list_rule_sets_request_response.go list_shapes_request_response.go list_work_requests_request_response.go listener.go listener_details.go listener_rule_summary.go load_balancer.go load_balancer_health.go load_balancer_health_summary.go load_balancer_policy.go load_balancer_protocol.go load_balancer_shape.go loadbalancer_client.go path_match_condition.go path_match_type.go path_route.go path_route_set.go path_route_set_details.go redirect_rule.go redirect_uri.go remove_http_request_header_rule.go remove_http_response_header_rule.go rule.go rule_condition.go rule_set.go rule_set_details.go session_persistence_configuration_details.go source_ip_address_condition.go source_vcn_id_condition.go source_vcn_ip_address_condition.go ssl_configuration.go ssl_configuration_details.go update_backend_details.go update_backend_request_response.go update_backend_set_details.go update_backend_set_request_response.go update_health_checker_details.go update_health_checker_request_response.go update_hostname_details.go update_hostname_request_response.go update_listener_details.go update_listener_request_response.go update_load_balancer_details.go update_load_balancer_request_response.go update_network_security_groups_details.go update_network_security_groups_request_response.go update_path_route_set_details.go update_path_route_set_request_response.go update_rule_set_details.go update_rule_set_request_response.go work_request.go work_request_error.go

type AddHttpRequestHeaderRule Uses

type AddHttpRequestHeaderRule struct {

    // A header name that conforms to RFC 7230.
    // Example: `example_header_name`
    Header *string `mandatory:"true" json:"header"`

    // A header value that conforms to RFC 7230.
    // Example: `example_value`
    Value *string `mandatory:"true" json:"value"`
}

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` and `example-header-name` as identical. Oracle recommends that you do not rely on underscore
or dash characters to uniquely distinguish header names.

func (AddHttpRequestHeaderRule) MarshalJSON Uses

func (m AddHttpRequestHeaderRule) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AddHttpRequestHeaderRule) String Uses

func (m AddHttpRequestHeaderRule) String() string

type AddHttpResponseHeaderRule Uses

type AddHttpResponseHeaderRule struct {

    // A header name that conforms to RFC 7230.
    // Example: `example_header_name`
    Header *string `mandatory:"true" json:"header"`

    // A header value that conforms to RFC 7230.
    // Example: `example_value`
    Value *string `mandatory:"true" json:"value"`
}

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` and `example-header-name` as identical. Oracle recommends that you do not rely on underscore
or dash characters to uniquely distinguish header names.

func (AddHttpResponseHeaderRule) MarshalJSON Uses

func (m AddHttpResponseHeaderRule) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AddHttpResponseHeaderRule) String Uses

func (m AddHttpResponseHeaderRule) String() string

type AllowRule Uses

type AllowRule struct {
    Conditions []RuleCondition `mandatory:"true" json:"conditions"`

    // A brief description of the access control rule. Avoid entering confidential information.
    // example: `192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.`
    Description *string `mandatory:"false" json:"description"`
}

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`

func (AllowRule) MarshalJSON Uses

func (m AllowRule) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AllowRule) String Uses

func (m AllowRule) String() string

func (*AllowRule) UnmarshalJSON Uses

func (m *AllowRule) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type Backend Uses

type Backend struct {

    // A read-only field showing the IP address and port that uniquely identify this backend server in the backend set.
    // Example: `10.0.0.3:8080`
    Name *string `mandatory:"true" json:"name"`

    // The IP address of the backend server.
    // Example: `10.0.0.3`
    IpAddress *string `mandatory:"true" json:"ipAddress"`

    // The communication port for the backend server.
    // Example: `8080`
    Port *int `mandatory:"true" json:"port"`

    // The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger
    // proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections
    // as a server weighted '1'.
    // For more information on load balancing policies, see
    // How Load Balancing Policies Work (https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm).
    // Example: `3`
    Weight *int `mandatory:"true" json:"weight"`

    // Whether the load balancer should drain this server. Servers marked "drain" receive no new
    // incoming traffic.
    // Example: `false`
    Drain *bool `mandatory:"true" json:"drain"`

    // Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress
    // traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.
    // **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy.
    // Example: `false`
    Backup *bool `mandatory:"true" json:"backup"`

    // Whether the load balancer should treat this server as offline. Offline servers receive no incoming
    // traffic.
    // Example: `false`
    Offline *bool `mandatory:"true" json:"offline"`
}

Backend The configuration of a backend server that is a member of a load balancer backend set. For more information, see Managing Backend Servers (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendservers.htm).

func (Backend) String Uses

func (m Backend) String() string

type BackendDetails Uses

type BackendDetails struct {

    // The IP address of the backend server.
    // Example: `10.0.0.3`
    IpAddress *string `mandatory:"true" json:"ipAddress"`

    // The communication port for the backend server.
    // Example: `8080`
    Port *int `mandatory:"true" json:"port"`

    // The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger
    // proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections
    // as a server weighted '1'.
    // For more information on load balancing policies, see
    // How Load Balancing Policies Work (https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm).
    // Example: `3`
    Weight *int `mandatory:"false" json:"weight"`

    // Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress
    // traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.
    // **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy.
    // Example: `false`
    Backup *bool `mandatory:"false" json:"backup"`

    // Whether the load balancer should drain this server. Servers marked "drain" receive no new
    // incoming traffic.
    // Example: `false`
    Drain *bool `mandatory:"false" json:"drain"`

    // Whether the load balancer should treat this server as offline. Offline servers receive no incoming
    // traffic.
    // Example: `false`
    Offline *bool `mandatory:"false" json:"offline"`
}

BackendDetails The load balancing configuration details of a backend server.

func (BackendDetails) String Uses

func (m BackendDetails) String() string

type BackendHealth Uses

type BackendHealth struct {

    // The general health status of the specified backend server as reported by the primary and standby load balancers.
    // *   **OK:** Both health checks returned `OK`.
    // *   **WARNING:** One health check returned `OK` and one did not.
    // *   **CRITICAL:** Neither health check returned `OK`.
    // *   **UNKNOWN:** One or both health checks returned `UNKNOWN`, or the system was unable to retrieve metrics at this time.
    Status BackendHealthStatusEnum `mandatory:"true" json:"status"`

    // A list of the most recent health check results returned for the specified backend server.
    HealthCheckResults []HealthCheckResult `mandatory:"true" json:"healthCheckResults"`
}

BackendHealth The health status of the specified backend server as reported by the primary and standby load balancers.

func (BackendHealth) String Uses

func (m BackendHealth) String() string

type BackendHealthStatusEnum Uses

type BackendHealthStatusEnum string

BackendHealthStatusEnum Enum with underlying type: string

const (
    BackendHealthStatusOk       BackendHealthStatusEnum = "OK"
    BackendHealthStatusWarning  BackendHealthStatusEnum = "WARNING"
    BackendHealthStatusCritical BackendHealthStatusEnum = "CRITICAL"
    BackendHealthStatusUnknown  BackendHealthStatusEnum = "UNKNOWN"
)

Set of constants representing the allowable values for BackendHealthStatusEnum

func GetBackendHealthStatusEnumValues Uses

func GetBackendHealthStatusEnumValues() []BackendHealthStatusEnum

GetBackendHealthStatusEnumValues Enumerates the set of values for BackendHealthStatusEnum

type BackendSet Uses

type BackendSet struct {

    // A friendly name for the backend set. It must be unique and it cannot be changed.
    // Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot
    // contain spaces. Avoid entering confidential information.
    // Example: `example_backend_set`
    Name *string `mandatory:"true" json:"name"`

    // The load balancer policy for the backend set. To get a list of available policies, use the
    // ListPolicies operation.
    // Example: `LEAST_CONNECTIONS`
    Policy *string `mandatory:"true" json:"policy"`

    Backends []Backend `mandatory:"true" json:"backends"`

    HealthChecker *HealthChecker `mandatory:"true" json:"healthChecker"`

    SslConfiguration *SslConfiguration `mandatory:"false" json:"sslConfiguration"`

    SessionPersistenceConfiguration *SessionPersistenceConfigurationDetails `mandatory:"false" json:"sessionPersistenceConfiguration"`

    LbCookieSessionPersistenceConfiguration *LbCookieSessionPersistenceConfigurationDetails `mandatory:"false" json:"lbCookieSessionPersistenceConfiguration"`
}

BackendSet The configuration of a load balancer backend set. For more information on backend set configuration, see Managing Backend Sets (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendsets.htm). **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.

func (BackendSet) String Uses

func (m BackendSet) String() string

type BackendSetDetails Uses

type BackendSetDetails struct {

    // The load balancer policy for the backend set. To get a list of available policies, use the
    // ListPolicies operation.
    // Example: `LEAST_CONNECTIONS`
    Policy *string `mandatory:"true" json:"policy"`

    HealthChecker *HealthCheckerDetails `mandatory:"true" json:"healthChecker"`

    Backends []BackendDetails `mandatory:"false" json:"backends"`

    SslConfiguration *SslConfigurationDetails `mandatory:"false" json:"sslConfiguration"`

    SessionPersistenceConfiguration *SessionPersistenceConfigurationDetails `mandatory:"false" json:"sessionPersistenceConfiguration"`

    LbCookieSessionPersistenceConfiguration *LbCookieSessionPersistenceConfigurationDetails `mandatory:"false" json:"lbCookieSessionPersistenceConfiguration"`
}

BackendSetDetails The configuration details for a load balancer backend set. For more information on backend set configuration, see Managing Backend Sets (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendsets.htm). **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.

func (BackendSetDetails) String Uses

func (m BackendSetDetails) String() string

type BackendSetHealth Uses

type BackendSetHealth struct {

    // Overall health status of the backend set.
    // *  **OK:** All backend servers in the backend set return a status of `OK`.
    // *  **WARNING:** Half or more of the backend set's backend servers return a status of `OK` and at least one backend
    // server returns a status of `WARNING`, `CRITICAL`, or `UNKNOWN`.
    // *  **CRITICAL:** Fewer than half of the backend set's backend servers return a status of `OK`.
    // *  **UNKNOWN:** More than half of the backend set's backend servers return a status of `UNKNOWN`, the system was
    // unable to retrieve metrics, or the backend set does not have a listener attached.
    Status BackendSetHealthStatusEnum `mandatory:"true" json:"status"`

    // A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by
    // IP address and port.
    // Example: `10.0.0.3:8080`
    WarningStateBackendNames []string `mandatory:"true" json:"warningStateBackendNames"`

    // A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by
    // IP address and port.
    // Example: `10.0.0.4:8080`
    CriticalStateBackendNames []string `mandatory:"true" json:"criticalStateBackendNames"`

    // A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by
    // IP address and port.
    // Example: `10.0.0.5:8080`
    UnknownStateBackendNames []string `mandatory:"true" json:"unknownStateBackendNames"`

    // The total number of backend servers in this backend set.
    // Example: `7`
    TotalBackendCount *int `mandatory:"true" json:"totalBackendCount"`
}

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.

func (BackendSetHealth) String Uses

func (m BackendSetHealth) String() string

type BackendSetHealthStatusEnum Uses

type BackendSetHealthStatusEnum string

BackendSetHealthStatusEnum Enum with underlying type: string

const (
    BackendSetHealthStatusOk       BackendSetHealthStatusEnum = "OK"
    BackendSetHealthStatusWarning  BackendSetHealthStatusEnum = "WARNING"
    BackendSetHealthStatusCritical BackendSetHealthStatusEnum = "CRITICAL"
    BackendSetHealthStatusUnknown  BackendSetHealthStatusEnum = "UNKNOWN"
)

Set of constants representing the allowable values for BackendSetHealthStatusEnum

func GetBackendSetHealthStatusEnumValues Uses

func GetBackendSetHealthStatusEnumValues() []BackendSetHealthStatusEnum

GetBackendSetHealthStatusEnumValues Enumerates the set of values for BackendSetHealthStatusEnum

type Certificate Uses

type Certificate struct {

    // A friendly name for the certificate bundle. It must be unique and it cannot be changed.
    // Valid certificate bundle names include only alphanumeric characters, dashes, and underscores.
    // Certificate bundle names cannot contain spaces. Avoid entering confidential information.
    // Example: `example_certificate_bundle`
    CertificateName *string `mandatory:"true" json:"certificateName"`

    // The public certificate, in PEM format, that you received from your SSL certificate provider.
    // Example:
    //     -----BEGIN CERTIFICATE-----
    //     MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG
    //     A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE
    //     MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl
    //     YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw
    //     ...
    //     -----END CERTIFICATE-----
    PublicCertificate *string `mandatory:"true" json:"publicCertificate"`

    // The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider.
    // Example:
    //     -----BEGIN CERTIFICATE-----
    //     MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix
    //     EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD
    //     VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y
    //     aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy
    //     ...
    //     -----END CERTIFICATE-----
    CaCertificate *string `mandatory:"true" json:"caCertificate"`
}

Certificate The configuration details of a certificate bundle. For more information on SSL certficate configuration, see Managing SSL Certificates (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingcertificates.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Certificate) String Uses

func (m Certificate) String() string

type CertificateDetails Uses

type CertificateDetails struct {

    // A friendly name for the certificate bundle. It must be unique and it cannot be changed.
    // Valid certificate bundle names include only alphanumeric characters, dashes, and underscores.
    // Certificate bundle names cannot contain spaces. Avoid entering confidential information.
    // Example: `example_certificate_bundle`
    CertificateName *string `mandatory:"true" json:"certificateName"`

    // A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase.
    Passphrase *string `mandatory:"false" json:"passphrase"`

    // The SSL private key for your certificate, in PEM format.
    // Example:
    //     -----BEGIN RSA PRIVATE KEY-----
    //     jO1O1v2ftXMsawM90tnXwc6xhOAT1gDBC9S8DKeca..JZNUgYYwNS0dP2UK
    //     tmyN+XqVcAKw4HqVmChXy5b5msu8eIq3uc2NqNVtR..2ksSLukP8pxXcHyb
    //     +sEwvM4uf8qbnHAqwnOnP9+KV9vds6BaH1eRA4CHz..n+NVZlzBsTxTlS16
    //     /Umr7wJzVrMqK5sDiSu4WuaaBdqMGfL5hLsTjcBFD..Da2iyQmSKuVD4lIZ
    //     ...
    //     -----END RSA PRIVATE KEY-----
    PrivateKey *string `mandatory:"false" json:"privateKey"`

    // The public certificate, in PEM format, that you received from your SSL certificate provider.
    // Example:
    //     -----BEGIN CERTIFICATE-----
    //     MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG
    //     A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE
    //     MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl
    //     YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw
    //     ...
    //     -----END CERTIFICATE-----
    PublicCertificate *string `mandatory:"false" json:"publicCertificate"`

    // The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider.
    // Example:
    //     -----BEGIN CERTIFICATE-----
    //     MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix
    //     EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD
    //     VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y
    //     aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy
    //     ...
    //     -----END CERTIFICATE-----
    CaCertificate *string `mandatory:"false" json:"caCertificate"`
}

CertificateDetails The configuration details for a certificate bundle. For more information on SSL certficate configuration, see Managing SSL Certificates (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingcertificates.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (CertificateDetails) String Uses

func (m CertificateDetails) String() string

type ChangeLoadBalancerCompartmentDetails Uses

type ChangeLoadBalancerCompartmentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the load balancer to.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

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.

func (ChangeLoadBalancerCompartmentDetails) String Uses

func (m ChangeLoadBalancerCompartmentDetails) String() string

type ChangeLoadBalancerCompartmentRequest Uses

type ChangeLoadBalancerCompartmentRequest struct {

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer to move.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The configuration details for moving a load balancer to a different compartment.
    ChangeLoadBalancerCompartmentDetails `contributesTo:"body"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // For optimistic concurrency control. Set the if-match parameter to the value of the ETag from a
    // previous GET or POST response for that resource. The resource is moved only if the ETag you
    // provide matches the resource's current ETag value.
    // Example: `example-etag`
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ChangeLoadBalancerCompartmentRequest wrapper for the ChangeLoadBalancerCompartment operation

func (ChangeLoadBalancerCompartmentRequest) HTTPRequest Uses

func (request ChangeLoadBalancerCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeLoadBalancerCompartmentRequest) RetryPolicy Uses

func (request ChangeLoadBalancerCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeLoadBalancerCompartmentRequest) String Uses

func (request ChangeLoadBalancerCompartmentRequest) String() string

type ChangeLoadBalancerCompartmentResponse Uses

type ChangeLoadBalancerCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ChangeLoadBalancerCompartmentResponse wrapper for the ChangeLoadBalancerCompartment operation

func (ChangeLoadBalancerCompartmentResponse) HTTPResponse Uses

func (response ChangeLoadBalancerCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeLoadBalancerCompartmentResponse) String Uses

func (response ChangeLoadBalancerCompartmentResponse) String() string

type ConnectionConfiguration Uses

type ConnectionConfiguration struct {

    // The maximum idle time, in seconds, allowed between two successive receive or two successive send operations
    // between the client and backend servers. A send operation does not reset the timer for receive operations. A
    // receive operation does not reset the timer for send operations.
    // For more information, see Connection Configuration (https://docs.cloud.oracle.com/Content/Balance/Reference/connectionreuse.htm#ConnectionConfiguration).
    // Example: `1200`
    IdleTimeout *int64 `mandatory:"true" json:"idleTimeout"`

    // The backend TCP Proxy Protocol version.
    // Example: `1`
    BackendTcpProxyProtocolVersion *int `mandatory:"false" json:"backendTcpProxyProtocolVersion"`
}

ConnectionConfiguration Configuration details for the connection between the client and backend servers.

func (ConnectionConfiguration) String Uses

func (m ConnectionConfiguration) String() string

type ControlAccessUsingHttpMethodsRule Uses

type ControlAccessUsingHttpMethodsRule struct {

    // The list of HTTP methods allowed for this listener.
    // By default, you can specify only the standard HTTP methods defined in the
    // HTTP Method Registry (http://www.iana.org/assignments/http-methods/http-methods.xhtml). You can also
    // see a list of supported standard HTTP methods in the Load Balancing service documentation at
    // Managing Rule Sets (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrulesets.htm).
    // Your backend application must be able to handle the methods specified in this list.
    // The list of HTTP methods is extensible. If you need to configure custom HTTP methods, contact
    // My Oracle Support (http://support.oracle.com/) to remove the restriction for your tenancy.
    // Example: ["GET", "PUT", "POST", "PROPFIND"]
    AllowedMethods []string `mandatory:"true" json:"allowedMethods"`

    // The HTTP status code to return when the requested HTTP method is not in the list of allowed methods.
    // The associated status line returned with the code is mapped from the standard HTTP specification. The
    // default value is `405 (Method Not Allowed)`.
    // Example: 403
    StatusCode *int `mandatory:"false" json:"statusCode"`
}

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.

func (ControlAccessUsingHttpMethodsRule) MarshalJSON Uses

func (m ControlAccessUsingHttpMethodsRule) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ControlAccessUsingHttpMethodsRule) String Uses

func (m ControlAccessUsingHttpMethodsRule) String() string

type CreateBackendDetails Uses

type CreateBackendDetails struct {

    // The IP address of the backend server.
    // Example: `10.0.0.3`
    IpAddress *string `mandatory:"true" json:"ipAddress"`

    // The communication port for the backend server.
    // Example: `8080`
    Port *int `mandatory:"true" json:"port"`

    // The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger
    // proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections
    // as a server weighted '1'.
    // For more information on load balancing policies, see
    // How Load Balancing Policies Work (https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm).
    // Example: `3`
    Weight *int `mandatory:"false" json:"weight"`

    // Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress
    // traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.
    // **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy.
    // Example: `false`
    Backup *bool `mandatory:"false" json:"backup"`

    // Whether the load balancer should drain this server. Servers marked "drain" receive no new
    // incoming traffic.
    // Example: `false`
    Drain *bool `mandatory:"false" json:"drain"`

    // Whether the load balancer should treat this server as offline. Offline servers receive no incoming
    // traffic.
    // Example: `false`
    Offline *bool `mandatory:"false" json:"offline"`
}

CreateBackendDetails The configuration details for creating a backend server in a backend set. For more information on backend server configuration, see Managing Backend Servers (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendservers.htm).

func (CreateBackendDetails) String Uses

func (m CreateBackendDetails) String() string

type CreateBackendRequest Uses

type CreateBackendRequest struct {

    // The details to add a backend server to a backend set.
    CreateBackendDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and servers.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the backend set to add the backend server to.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateBackendRequest wrapper for the CreateBackend operation

func (CreateBackendRequest) HTTPRequest Uses

func (request CreateBackendRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBackendRequest) RetryPolicy Uses

func (request CreateBackendRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateBackendRequest) String Uses

func (request CreateBackendRequest) String() string

type CreateBackendResponse Uses

type CreateBackendResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateBackendResponse wrapper for the CreateBackend operation

func (CreateBackendResponse) HTTPResponse Uses

func (response CreateBackendResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateBackendResponse) String Uses

func (response CreateBackendResponse) String() string

type CreateBackendSetDetails Uses

type CreateBackendSetDetails struct {

    // A friendly name for the backend set. It must be unique and it cannot be changed.
    // Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot
    // contain spaces. Avoid entering confidential information.
    // Example: `example_backend_set`
    Name *string `mandatory:"true" json:"name"`

    // The load balancer policy for the backend set. To get a list of available policies, use the
    // ListPolicies operation.
    // Example: `LEAST_CONNECTIONS`
    Policy *string `mandatory:"true" json:"policy"`

    HealthChecker *HealthCheckerDetails `mandatory:"true" json:"healthChecker"`

    Backends []BackendDetails `mandatory:"false" json:"backends"`

    SslConfiguration *SslConfigurationDetails `mandatory:"false" json:"sslConfiguration"`

    SessionPersistenceConfiguration *SessionPersistenceConfigurationDetails `mandatory:"false" json:"sessionPersistenceConfiguration"`

    LbCookieSessionPersistenceConfiguration *LbCookieSessionPersistenceConfigurationDetails `mandatory:"false" json:"lbCookieSessionPersistenceConfiguration"`
}

CreateBackendSetDetails The configuration details for creating a backend set in a load balancer. For more information on backend set configuration, see Managing Backend Sets (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendsets.htm). **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.

func (CreateBackendSetDetails) String Uses

func (m CreateBackendSetDetails) String() string

type CreateBackendSetRequest Uses

type CreateBackendSetRequest struct {

    // The details for adding a backend set.
    CreateBackendSetDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer on which to add a backend set.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateBackendSetRequest wrapper for the CreateBackendSet operation

func (CreateBackendSetRequest) HTTPRequest Uses

func (request CreateBackendSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBackendSetRequest) RetryPolicy Uses

func (request CreateBackendSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateBackendSetRequest) String Uses

func (request CreateBackendSetRequest) String() string

type CreateBackendSetResponse Uses

type CreateBackendSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateBackendSetResponse wrapper for the CreateBackendSet operation

func (CreateBackendSetResponse) HTTPResponse Uses

func (response CreateBackendSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateBackendSetResponse) String Uses

func (response CreateBackendSetResponse) String() string

type CreateCertificateDetails Uses

type CreateCertificateDetails struct {

    // A friendly name for the certificate bundle. It must be unique and it cannot be changed.
    // Valid certificate bundle names include only alphanumeric characters, dashes, and underscores.
    // Certificate bundle names cannot contain spaces. Avoid entering confidential information.
    // Example: `example_certificate_bundle`
    CertificateName *string `mandatory:"true" json:"certificateName"`

    // A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase.
    Passphrase *string `mandatory:"false" json:"passphrase"`

    // The SSL private key for your certificate, in PEM format.
    // Example:
    //     -----BEGIN RSA PRIVATE KEY-----
    //     jO1O1v2ftXMsawM90tnXwc6xhOAT1gDBC9S8DKeca..JZNUgYYwNS0dP2UK
    //     tmyN+XqVcAKw4HqVmChXy5b5msu8eIq3uc2NqNVtR..2ksSLukP8pxXcHyb
    //     +sEwvM4uf8qbnHAqwnOnP9+KV9vds6BaH1eRA4CHz..n+NVZlzBsTxTlS16
    //     /Umr7wJzVrMqK5sDiSu4WuaaBdqMGfL5hLsTjcBFD..Da2iyQmSKuVD4lIZ
    //     ...
    //     -----END RSA PRIVATE KEY-----
    PrivateKey *string `mandatory:"false" json:"privateKey"`

    // The public certificate, in PEM format, that you received from your SSL certificate provider.
    // Example:
    //     -----BEGIN CERTIFICATE-----
    //     MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbM..QswCQYDVQQGEwJKU
    //     A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxE..TAPBgNVBAoTCEZyY
    //     MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWB..gNVBAMTD0ZyYW5rN
    //     YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmc..mFuazRkZC5jb20wH
    //     ...
    //     -----END CERTIFICATE-----
    PublicCertificate *string `mandatory:"false" json:"publicCertificate"`

    // The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider.
    // Example:
    //     -----BEGIN CERTIFICATE-----
    //     MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix
    //     EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD
    //     VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y
    //     aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy
    //     ...
    //     -----END CERTIFICATE-----
    CaCertificate *string `mandatory:"false" json:"caCertificate"`
}

CreateCertificateDetails The configuration details for adding a certificate bundle to a listener. For more information on SSL certficate configuration, see Managing SSL Certificates (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingcertificates.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (CreateCertificateDetails) String Uses

func (m CreateCertificateDetails) String() string

type CreateCertificateRequest Uses

type CreateCertificateRequest struct {

    // The details of the certificate bundle to add.
    CreateCertificateDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer on which to add the certificate bundle.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateCertificateRequest wrapper for the CreateCertificate operation

func (CreateCertificateRequest) HTTPRequest Uses

func (request CreateCertificateRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateCertificateRequest) RetryPolicy Uses

func (request CreateCertificateRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateCertificateRequest) String Uses

func (request CreateCertificateRequest) String() string

type CreateCertificateResponse Uses

type CreateCertificateResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateCertificateResponse wrapper for the CreateCertificate operation

func (CreateCertificateResponse) HTTPResponse Uses

func (response CreateCertificateResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateCertificateResponse) String Uses

func (response CreateCertificateResponse) String() string

type CreateHostnameDetails Uses

type CreateHostnameDetails struct {

    // A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential
    // information.
    // Example: `example_hostname_001`
    Name *string `mandatory:"true" json:"name"`

    // A virtual hostname. For more information about virtual hostname string construction, see
    // Managing Request Routing (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm#routing).
    // Example: `app.example.com`
    Hostname *string `mandatory:"true" json:"hostname"`
}

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.

func (CreateHostnameDetails) String Uses

func (m CreateHostnameDetails) String() string

type CreateHostnameRequest Uses

type CreateHostnameRequest struct {

    // The details of the hostname resource to add to the specified load balancer.
    CreateHostnameDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer to add the hostname to.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateHostnameRequest wrapper for the CreateHostname operation

func (CreateHostnameRequest) HTTPRequest Uses

func (request CreateHostnameRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateHostnameRequest) RetryPolicy Uses

func (request CreateHostnameRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateHostnameRequest) String Uses

func (request CreateHostnameRequest) String() string

type CreateHostnameResponse Uses

type CreateHostnameResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateHostnameResponse wrapper for the CreateHostname operation

func (CreateHostnameResponse) HTTPResponse Uses

func (response CreateHostnameResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateHostnameResponse) String Uses

func (response CreateHostnameResponse) String() string

type CreateListenerDetails Uses

type CreateListenerDetails struct {

    // The name of the associated backend set.
    // Example: `example_backend_set`
    DefaultBackendSetName *string `mandatory:"true" json:"defaultBackendSetName"`

    // The communication port for the listener.
    // Example: `80`
    Port *int `mandatory:"true" json:"port"`

    // The protocol on which the listener accepts connection requests.
    // To get a list of valid protocols, use the ListProtocols
    // operation.
    // Example: `HTTP`
    Protocol *string `mandatory:"true" json:"protocol"`

    // A friendly name for the listener. It must be unique and it cannot be changed.
    // Avoid entering confidential information.
    // Example: `example_listener`
    Name *string `mandatory:"true" json:"name"`

    // An array of hostname resource names.
    HostnameNames []string `mandatory:"false" json:"hostnameNames"`

    // The name of the set of path-based routing rules, PathRouteSet,
    // applied to this listener's traffic.
    // Example: `example_path_route_set`
    PathRouteSetName *string `mandatory:"false" json:"pathRouteSetName"`

    SslConfiguration *SslConfigurationDetails `mandatory:"false" json:"sslConfiguration"`

    ConnectionConfiguration *ConnectionConfiguration `mandatory:"false" json:"connectionConfiguration"`

    // The names of the RuleSet to apply to the listener.
    // Example: ["example_rule_set"]
    RuleSetNames []string `mandatory:"false" json:"ruleSetNames"`
}

CreateListenerDetails The configuration details for adding a listener to a backend set. For more information on listener configuration, see Managing Load Balancer Listeners (https://docs.cloud.oracle.com/Content/Balance/Tasks/managinglisteners.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (CreateListenerDetails) String Uses

func (m CreateListenerDetails) String() string

type CreateListenerRequest Uses

type CreateListenerRequest struct {

    // Details to add a listener.
    CreateListenerDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer on which to add a listener.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateListenerRequest wrapper for the CreateListener operation

func (CreateListenerRequest) HTTPRequest Uses

func (request CreateListenerRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateListenerRequest) RetryPolicy Uses

func (request CreateListenerRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateListenerRequest) String Uses

func (request CreateListenerRequest) String() string

type CreateListenerResponse Uses

type CreateListenerResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateListenerResponse wrapper for the CreateListener operation

func (CreateListenerResponse) HTTPResponse Uses

func (response CreateListenerResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateListenerResponse) String Uses

func (response CreateListenerResponse) String() string

type CreateLoadBalancerDetails Uses

type CreateLoadBalancerDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which to create the load balancer.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    // Example: `example_load_balancer`
    DisplayName *string `mandatory:"true" json:"displayName"`

    // A template that determines the total pre-provisioned bandwidth (ingress plus egress).
    // To get a list of available shapes, use the ListShapes
    // operation.
    // Example: `100Mbps`
    ShapeName *string `mandatory:"true" json:"shapeName"`

    // An array of subnet OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
    SubnetIds []string `mandatory:"true" json:"subnetIds"`

    // Whether the load balancer has a VCN-local (private) IP address.
    // If "true", the service assigns a private IP address to the load balancer.
    // If "false", the service assigns a public IP address to the load balancer.
    // A public load balancer is accessible from the internet, depending on your VCN's
    // security list rules (https://docs.cloud.oracle.com/Content/Network/Concepts/securitylists.htm). For more information about public and
    // private load balancers, see How Load Balancing Works (https://docs.cloud.oracle.com/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works).
    // Example: `true`
    IsPrivate *bool `mandatory:"false" json:"isPrivate"`

    // Whether the load balancer has an IPv4 or IPv6 IP address.
    // If "IPV4", the service assigns an IPv4 address and the load balancer supports IPv4 traffic.
    // If "IPV6", the service assigns an IPv6 address and the load balancer supports IPv6 traffic.
    // Example: "ipMode":"IPV6"
    IpMode CreateLoadBalancerDetailsIpModeEnum `mandatory:"false" json:"ipMode,omitempty"`

    Listeners map[string]ListenerDetails `mandatory:"false" json:"listeners"`

    Hostnames map[string]HostnameDetails `mandatory:"false" json:"hostnames"`

    BackendSets map[string]BackendSetDetails `mandatory:"false" json:"backendSets"`

    // An array of NSG OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with this load balancer.
    // During the load balancer's creation, the service adds the new load balancer to the specified NSGs.
    // The benefits of using NSGs with the load balancer include:
    // *  NSGs define network security rules to govern ingress and egress traffic for the load balancer.
    // *  The network security rules of other resources can reference the NSGs associated with the load balancer
    //    to ensure access.
    // Example: `["ocid1.nsg.oc1.phx.unique_ID"]`
    NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`

    Certificates map[string]CertificateDetails `mandatory:"false" json:"certificates"`

    PathRouteSets map[string]PathRouteSetDetails `mandatory:"false" json:"pathRouteSets"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    RuleSets map[string]RuleSetDetails `mandatory:"false" json:"ruleSets"`
}

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.

func (CreateLoadBalancerDetails) String Uses

func (m CreateLoadBalancerDetails) String() string

type CreateLoadBalancerDetailsIpModeEnum Uses

type CreateLoadBalancerDetailsIpModeEnum string

CreateLoadBalancerDetailsIpModeEnum Enum with underlying type: string

const (
    CreateLoadBalancerDetailsIpModeIpv4 CreateLoadBalancerDetailsIpModeEnum = "IPV4"
    CreateLoadBalancerDetailsIpModeIpv6 CreateLoadBalancerDetailsIpModeEnum = "IPV6"
)

Set of constants representing the allowable values for CreateLoadBalancerDetailsIpModeEnum

func GetCreateLoadBalancerDetailsIpModeEnumValues Uses

func GetCreateLoadBalancerDetailsIpModeEnumValues() []CreateLoadBalancerDetailsIpModeEnum

GetCreateLoadBalancerDetailsIpModeEnumValues Enumerates the set of values for CreateLoadBalancerDetailsIpModeEnum

type CreateLoadBalancerRequest Uses

type CreateLoadBalancerRequest struct {

    // The configuration details for creating a load balancer.
    CreateLoadBalancerDetails `contributesTo:"body"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateLoadBalancerRequest wrapper for the CreateLoadBalancer operation

func (CreateLoadBalancerRequest) HTTPRequest Uses

func (request CreateLoadBalancerRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateLoadBalancerRequest) RetryPolicy Uses

func (request CreateLoadBalancerRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateLoadBalancerRequest) String Uses

func (request CreateLoadBalancerRequest) String() string

type CreateLoadBalancerResponse Uses

type CreateLoadBalancerResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateLoadBalancerResponse wrapper for the CreateLoadBalancer operation

func (CreateLoadBalancerResponse) HTTPResponse Uses

func (response CreateLoadBalancerResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateLoadBalancerResponse) String Uses

func (response CreateLoadBalancerResponse) String() string

type CreatePathRouteSetDetails Uses

type CreatePathRouteSetDetails struct {

    // The name for this set of path route rules. It must be unique and it cannot be changed. Avoid entering
    // confidential information.
    // Example: `example_path_route_set`
    Name *string `mandatory:"true" json:"name"`

    // The set of path route rules.
    PathRoutes []PathRoute `mandatory:"true" json:"pathRoutes"`
}

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.

func (CreatePathRouteSetDetails) String Uses

func (m CreatePathRouteSetDetails) String() string

type CreatePathRouteSetRequest Uses

type CreatePathRouteSetRequest struct {

    // The details of the path route set to add.
    CreatePathRouteSetDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer to add the path route set to.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreatePathRouteSetRequest wrapper for the CreatePathRouteSet operation

func (CreatePathRouteSetRequest) HTTPRequest Uses

func (request CreatePathRouteSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreatePathRouteSetRequest) RetryPolicy Uses

func (request CreatePathRouteSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreatePathRouteSetRequest) String Uses

func (request CreatePathRouteSetRequest) String() string

type CreatePathRouteSetResponse Uses

type CreatePathRouteSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreatePathRouteSetResponse wrapper for the CreatePathRouteSet operation

func (CreatePathRouteSetResponse) HTTPResponse Uses

func (response CreatePathRouteSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreatePathRouteSetResponse) String Uses

func (response CreatePathRouteSetResponse) String() string

type CreateRuleSetDetails Uses

type CreateRuleSetDetails struct {

    // The name for this set of rules. It must be unique and it cannot be changed. Avoid entering
    // confidential information.
    // Example: `example_rule_set`
    Name *string `mandatory:"true" json:"name"`

    // An array of rules that compose the rule set.
    Items []Rule `mandatory:"true" json:"items"`
}

CreateRuleSetDetails A named set of rules to add to the load balancer.

func (CreateRuleSetDetails) String Uses

func (m CreateRuleSetDetails) String() string

func (*CreateRuleSetDetails) UnmarshalJSON Uses

func (m *CreateRuleSetDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type CreateRuleSetRequest Uses

type CreateRuleSetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the specified load balancer.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The configuration details for the rule set to create.
    CreateRuleSetDetails `contributesTo:"body"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateRuleSetRequest wrapper for the CreateRuleSet operation

func (CreateRuleSetRequest) HTTPRequest Uses

func (request CreateRuleSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateRuleSetRequest) RetryPolicy Uses

func (request CreateRuleSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateRuleSetRequest) String Uses

func (request CreateRuleSetRequest) String() string

type CreateRuleSetResponse Uses

type CreateRuleSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateRuleSetResponse wrapper for the CreateRuleSet operation

func (CreateRuleSetResponse) HTTPResponse Uses

func (response CreateRuleSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateRuleSetResponse) String Uses

func (response CreateRuleSetResponse) String() string

type DeleteBackendRequest Uses

type DeleteBackendRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the backend set associated with the backend server.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`

    // The IP address and port of the backend server to remove.
    // Example: `10.0.0.3:8080`
    BackendName *string `mandatory:"true" contributesTo:"path" name:"backendName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteBackendRequest wrapper for the DeleteBackend operation

func (DeleteBackendRequest) HTTPRequest Uses

func (request DeleteBackendRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBackendRequest) RetryPolicy Uses

func (request DeleteBackendRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteBackendRequest) String Uses

func (request DeleteBackendRequest) String() string

type DeleteBackendResponse Uses

type DeleteBackendResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteBackendResponse wrapper for the DeleteBackend operation

func (DeleteBackendResponse) HTTPResponse Uses

func (response DeleteBackendResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteBackendResponse) String Uses

func (response DeleteBackendResponse) String() string

type DeleteBackendSetRequest Uses

type DeleteBackendSetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the backend set to delete.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteBackendSetRequest wrapper for the DeleteBackendSet operation

func (DeleteBackendSetRequest) HTTPRequest Uses

func (request DeleteBackendSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBackendSetRequest) RetryPolicy Uses

func (request DeleteBackendSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteBackendSetRequest) String Uses

func (request DeleteBackendSetRequest) String() string

type DeleteBackendSetResponse Uses

type DeleteBackendSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteBackendSetResponse wrapper for the DeleteBackendSet operation

func (DeleteBackendSetResponse) HTTPResponse Uses

func (response DeleteBackendSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteBackendSetResponse) String Uses

func (response DeleteBackendSetResponse) String() string

type DeleteCertificateRequest Uses

type DeleteCertificateRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the certificate bundle
    // to be deleted.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the certificate bundle to delete.
    // Example: `example_certificate_bundle`
    CertificateName *string `mandatory:"true" contributesTo:"path" name:"certificateName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteCertificateRequest wrapper for the DeleteCertificate operation

func (DeleteCertificateRequest) HTTPRequest Uses

func (request DeleteCertificateRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteCertificateRequest) RetryPolicy Uses

func (request DeleteCertificateRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteCertificateRequest) String Uses

func (request DeleteCertificateRequest) String() string

type DeleteCertificateResponse Uses

type DeleteCertificateResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteCertificateResponse wrapper for the DeleteCertificate operation

func (DeleteCertificateResponse) HTTPResponse Uses

func (response DeleteCertificateResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteCertificateResponse) String Uses

func (response DeleteCertificateResponse) String() string

type DeleteHostnameRequest Uses

type DeleteHostnameRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the hostname to delete.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the hostname resource to delete.
    // Example: `example_hostname_001`
    Name *string `mandatory:"true" contributesTo:"path" name:"name"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteHostnameRequest wrapper for the DeleteHostname operation

func (DeleteHostnameRequest) HTTPRequest Uses

func (request DeleteHostnameRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteHostnameRequest) RetryPolicy Uses

func (request DeleteHostnameRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteHostnameRequest) String Uses

func (request DeleteHostnameRequest) String() string

type DeleteHostnameResponse Uses

type DeleteHostnameResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteHostnameResponse wrapper for the DeleteHostname operation

func (DeleteHostnameResponse) HTTPResponse Uses

func (response DeleteHostnameResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteHostnameResponse) String Uses

func (response DeleteHostnameResponse) String() string

type DeleteListenerRequest Uses

type DeleteListenerRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener to delete.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the listener to delete.
    // Example: `example_listener`
    ListenerName *string `mandatory:"true" contributesTo:"path" name:"listenerName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteListenerRequest wrapper for the DeleteListener operation

func (DeleteListenerRequest) HTTPRequest Uses

func (request DeleteListenerRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteListenerRequest) RetryPolicy Uses

func (request DeleteListenerRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteListenerRequest) String Uses

func (request DeleteListenerRequest) String() string

type DeleteListenerResponse Uses

type DeleteListenerResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteListenerResponse wrapper for the DeleteListener operation

func (DeleteListenerResponse) HTTPResponse Uses

func (response DeleteListenerResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteListenerResponse) String Uses

func (response DeleteListenerResponse) String() string

type DeleteLoadBalancerRequest Uses

type DeleteLoadBalancerRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer to delete.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteLoadBalancerRequest wrapper for the DeleteLoadBalancer operation

func (DeleteLoadBalancerRequest) HTTPRequest Uses

func (request DeleteLoadBalancerRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteLoadBalancerRequest) RetryPolicy Uses

func (request DeleteLoadBalancerRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteLoadBalancerRequest) String Uses

func (request DeleteLoadBalancerRequest) String() string

type DeleteLoadBalancerResponse Uses

type DeleteLoadBalancerResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteLoadBalancerResponse wrapper for the DeleteLoadBalancer operation

func (DeleteLoadBalancerResponse) HTTPResponse Uses

func (response DeleteLoadBalancerResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteLoadBalancerResponse) String Uses

func (response DeleteLoadBalancerResponse) String() string

type DeletePathRouteSetRequest Uses

type DeletePathRouteSetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route set to delete.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the path route set to delete.
    // Example: `example_path_route_set`
    PathRouteSetName *string `mandatory:"true" contributesTo:"path" name:"pathRouteSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeletePathRouteSetRequest wrapper for the DeletePathRouteSet operation

func (DeletePathRouteSetRequest) HTTPRequest Uses

func (request DeletePathRouteSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeletePathRouteSetRequest) RetryPolicy Uses

func (request DeletePathRouteSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeletePathRouteSetRequest) String Uses

func (request DeletePathRouteSetRequest) String() string

type DeletePathRouteSetResponse Uses

type DeletePathRouteSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeletePathRouteSetResponse wrapper for the DeletePathRouteSet operation

func (DeletePathRouteSetResponse) HTTPResponse Uses

func (response DeletePathRouteSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeletePathRouteSetResponse) String Uses

func (response DeletePathRouteSetResponse) String() string

type DeleteRuleSetRequest Uses

type DeleteRuleSetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the specified load balancer.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the rule set to delete.
    // Example: `example_rule_set`
    RuleSetName *string `mandatory:"true" contributesTo:"path" name:"ruleSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteRuleSetRequest wrapper for the DeleteRuleSet operation

func (DeleteRuleSetRequest) HTTPRequest Uses

func (request DeleteRuleSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteRuleSetRequest) RetryPolicy Uses

func (request DeleteRuleSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteRuleSetRequest) String Uses

func (request DeleteRuleSetRequest) String() string

type DeleteRuleSetResponse Uses

type DeleteRuleSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteRuleSetResponse wrapper for the DeleteRuleSet operation

func (DeleteRuleSetResponse) HTTPResponse Uses

func (response DeleteRuleSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteRuleSetResponse) String Uses

func (response DeleteRuleSetResponse) String() string

type ExtendHttpRequestHeaderValueRule Uses

type ExtendHttpRequestHeaderValueRule struct {

    // A header name that conforms to RFC 7230.
    // Example: `example_header_name`
    Header *string `mandatory:"true" json:"header"`

    // A string to prepend to the header value. The resulting header value must conform to RFC 7230.
    // Example: `example_prefix_value`
    Prefix *string `mandatory:"false" json:"prefix"`

    // A string to append to the header value. The resulting header value must conform to RFC 7230.
    // Example: `example_suffix_value`
    Suffix *string `mandatory:"false" json:"suffix"`
}

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` and `example-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.

func (ExtendHttpRequestHeaderValueRule) MarshalJSON Uses

func (m ExtendHttpRequestHeaderValueRule) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ExtendHttpRequestHeaderValueRule) String Uses

func (m ExtendHttpRequestHeaderValueRule) String() string

type ExtendHttpResponseHeaderValueRule Uses

type ExtendHttpResponseHeaderValueRule struct {

    // A header name that conforms to RFC 7230.
    // Example: `example_header_name`
    Header *string `mandatory:"true" json:"header"`

    // A string to prepend to the header value. The resulting header value must still conform to RFC 7230.
    // Example: `example_prefix_value`
    Prefix *string `mandatory:"false" json:"prefix"`

    // A string to append to the header value. The resulting header value must still conform to RFC 7230.
    // Example: `example_suffix_value`
    Suffix *string `mandatory:"false" json:"suffix"`
}

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` and `example-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.

func (ExtendHttpResponseHeaderValueRule) MarshalJSON Uses

func (m ExtendHttpResponseHeaderValueRule) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ExtendHttpResponseHeaderValueRule) String Uses

func (m ExtendHttpResponseHeaderValueRule) String() string

type GetBackendHealthRequest Uses

type GetBackendHealthRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend server health status to be retrieved.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the backend set associated with the backend server to retrieve the health status for.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`

    // The IP address and port of the backend server to retrieve the health status for.
    // Example: `10.0.0.3:8080`
    BackendName *string `mandatory:"true" contributesTo:"path" name:"backendName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetBackendHealthRequest wrapper for the GetBackendHealth operation

func (GetBackendHealthRequest) HTTPRequest Uses

func (request GetBackendHealthRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBackendHealthRequest) RetryPolicy Uses

func (request GetBackendHealthRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBackendHealthRequest) String Uses

func (request GetBackendHealthRequest) String() string

type GetBackendHealthResponse Uses

type GetBackendHealthResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The BackendHealth instance
    BackendHealth `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetBackendHealthResponse wrapper for the GetBackendHealth operation

func (GetBackendHealthResponse) HTTPResponse Uses

func (response GetBackendHealthResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBackendHealthResponse) String Uses

func (response GetBackendHealthResponse) String() string

type GetBackendRequest Uses

type GetBackendRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the backend set that includes the backend server.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`

    // The IP address and port of the backend server to retrieve.
    // Example: `10.0.0.3:8080`
    BackendName *string `mandatory:"true" contributesTo:"path" name:"backendName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetBackendRequest wrapper for the GetBackend operation

func (GetBackendRequest) HTTPRequest Uses

func (request GetBackendRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBackendRequest) RetryPolicy Uses

func (request GetBackendRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBackendRequest) String Uses

func (request GetBackendRequest) String() string

type GetBackendResponse Uses

type GetBackendResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Backend instance
    Backend `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetBackendResponse wrapper for the GetBackend operation

func (GetBackendResponse) HTTPResponse Uses

func (response GetBackendResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBackendResponse) String Uses

func (response GetBackendResponse) String() string

type GetBackendSetHealthRequest Uses

type GetBackendSetHealthRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set health status to be retrieved.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the backend set to retrieve the health status for.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetBackendSetHealthRequest wrapper for the GetBackendSetHealth operation

func (GetBackendSetHealthRequest) HTTPRequest Uses

func (request GetBackendSetHealthRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBackendSetHealthRequest) RetryPolicy Uses

func (request GetBackendSetHealthRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBackendSetHealthRequest) String Uses

func (request GetBackendSetHealthRequest) String() string

type GetBackendSetHealthResponse Uses

type GetBackendSetHealthResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The BackendSetHealth instance
    BackendSetHealth `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetBackendSetHealthResponse wrapper for the GetBackendSetHealth operation

func (GetBackendSetHealthResponse) HTTPResponse Uses

func (response GetBackendSetHealthResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBackendSetHealthResponse) String Uses

func (response GetBackendSetHealthResponse) String() string

type GetBackendSetRequest Uses

type GetBackendSetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the specified load balancer.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the backend set to retrieve.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetBackendSetRequest wrapper for the GetBackendSet operation

func (GetBackendSetRequest) HTTPRequest Uses

func (request GetBackendSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBackendSetRequest) RetryPolicy Uses

func (request GetBackendSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBackendSetRequest) String Uses

func (request GetBackendSetRequest) String() string

type GetBackendSetResponse Uses

type GetBackendSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The BackendSet instance
    BackendSet `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetBackendSetResponse wrapper for the GetBackendSet operation

func (GetBackendSetResponse) HTTPResponse Uses

func (response GetBackendSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBackendSetResponse) String Uses

func (response GetBackendSetResponse) String() string

type GetHealthCheckerRequest Uses

type GetHealthCheckerRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the health check policy to be retrieved.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the backend set associated with the health check policy to be retrieved.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetHealthCheckerRequest wrapper for the GetHealthChecker operation

func (GetHealthCheckerRequest) HTTPRequest Uses

func (request GetHealthCheckerRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetHealthCheckerRequest) RetryPolicy Uses

func (request GetHealthCheckerRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetHealthCheckerRequest) String Uses

func (request GetHealthCheckerRequest) String() string

type GetHealthCheckerResponse Uses

type GetHealthCheckerResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The HealthChecker instance
    HealthChecker `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetHealthCheckerResponse wrapper for the GetHealthChecker operation

func (GetHealthCheckerResponse) HTTPResponse Uses

func (response GetHealthCheckerResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetHealthCheckerResponse) String Uses

func (response GetHealthCheckerResponse) String() string

type GetHostnameRequest Uses

type GetHostnameRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the specified load balancer.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the hostname resource to retrieve.
    // Example: `example_hostname_001`
    Name *string `mandatory:"true" contributesTo:"path" name:"name"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetHostnameRequest wrapper for the GetHostname operation

func (GetHostnameRequest) HTTPRequest Uses

func (request GetHostnameRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetHostnameRequest) RetryPolicy Uses

func (request GetHostnameRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetHostnameRequest) String Uses

func (request GetHostnameRequest) String() string

type GetHostnameResponse Uses

type GetHostnameResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Hostname instance
    Hostname `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetHostnameResponse wrapper for the GetHostname operation

func (GetHostnameResponse) HTTPResponse Uses

func (response GetHostnameResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetHostnameResponse) String Uses

func (response GetHostnameResponse) String() string

type GetLoadBalancerHealthRequest Uses

type GetLoadBalancerHealthRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer to return health status for.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetLoadBalancerHealthRequest wrapper for the GetLoadBalancerHealth operation

func (GetLoadBalancerHealthRequest) HTTPRequest Uses

func (request GetLoadBalancerHealthRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetLoadBalancerHealthRequest) RetryPolicy Uses

func (request GetLoadBalancerHealthRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetLoadBalancerHealthRequest) String Uses

func (request GetLoadBalancerHealthRequest) String() string

type GetLoadBalancerHealthResponse Uses

type GetLoadBalancerHealthResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The LoadBalancerHealth instance
    LoadBalancerHealth `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetLoadBalancerHealthResponse wrapper for the GetLoadBalancerHealth operation

func (GetLoadBalancerHealthResponse) HTTPResponse Uses

func (response GetLoadBalancerHealthResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetLoadBalancerHealthResponse) String Uses

func (response GetLoadBalancerHealthResponse) String() string

type GetLoadBalancerRequest Uses

type GetLoadBalancerRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer to retrieve.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetLoadBalancerRequest wrapper for the GetLoadBalancer operation

func (GetLoadBalancerRequest) HTTPRequest Uses

func (request GetLoadBalancerRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetLoadBalancerRequest) RetryPolicy Uses

func (request GetLoadBalancerRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetLoadBalancerRequest) String Uses

func (request GetLoadBalancerRequest) String() string

type GetLoadBalancerResponse Uses

type GetLoadBalancerResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The LoadBalancer instance
    LoadBalancer `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetLoadBalancerResponse wrapper for the GetLoadBalancer operation

func (GetLoadBalancerResponse) HTTPResponse Uses

func (response GetLoadBalancerResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetLoadBalancerResponse) String Uses

func (response GetLoadBalancerResponse) String() string

type GetPathRouteSetRequest Uses

type GetPathRouteSetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the specified load balancer.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the path route set to retrieve.
    // Example: `example_path_route_set`
    PathRouteSetName *string `mandatory:"true" contributesTo:"path" name:"pathRouteSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetPathRouteSetRequest wrapper for the GetPathRouteSet operation

func (GetPathRouteSetRequest) HTTPRequest Uses

func (request GetPathRouteSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetPathRouteSetRequest) RetryPolicy Uses

func (request GetPathRouteSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetPathRouteSetRequest) String Uses

func (request GetPathRouteSetRequest) String() string

type GetPathRouteSetResponse Uses

type GetPathRouteSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The PathRouteSet instance
    PathRouteSet `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetPathRouteSetResponse wrapper for the GetPathRouteSet operation

func (GetPathRouteSetResponse) HTTPResponse Uses

func (response GetPathRouteSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetPathRouteSetResponse) String Uses

func (response GetPathRouteSetResponse) String() string

type GetRuleSetRequest Uses

type GetRuleSetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the specified load balancer.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the rule set to retrieve.
    // Example: `example_rule_set`
    RuleSetName *string `mandatory:"true" contributesTo:"path" name:"ruleSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetRuleSetRequest wrapper for the GetRuleSet operation

func (GetRuleSetRequest) HTTPRequest Uses

func (request GetRuleSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetRuleSetRequest) RetryPolicy Uses

func (request GetRuleSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetRuleSetRequest) String Uses

func (request GetRuleSetRequest) String() string

type GetRuleSetResponse Uses

type GetRuleSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The RuleSet instance
    RuleSet `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetRuleSetResponse wrapper for the GetRuleSet operation

func (GetRuleSetResponse) HTTPResponse Uses

func (response GetRuleSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetRuleSetResponse) String Uses

func (response GetRuleSetResponse) String() string

type GetWorkRequestRequest Uses

type GetWorkRequestRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request to retrieve.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

func (GetWorkRequestRequest) HTTPRequest Uses

func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy Uses

func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWorkRequestRequest) String Uses

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse Uses

type GetWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The WorkRequest instance
    WorkRequest `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse Uses

func (response GetWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String Uses

func (response GetWorkRequestResponse) String() string

type HealthCheckResult Uses

type HealthCheckResult struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet hosting the load balancer that reported this health check status.
    SubnetId *string `mandatory:"true" json:"subnetId"`

    // The IP address of the health check status report provider. This identifier helps you differentiate same-subnet
    // load balancers that report health check status.
    // Example: `10.0.0.7`
    SourceIpAddress *string `mandatory:"true" json:"sourceIpAddress"`

    // The date and time the data was retrieved, in the format defined by RFC3339.
    // Example: `2017-06-02T18:28:11+00:00`
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`

    // The result of the most recent health check.
    HealthCheckStatus HealthCheckResultHealthCheckStatusEnum `mandatory:"true" json:"healthCheckStatus"`
}

HealthCheckResult Information about a single backend server health check result reported by a load balancer.

func (HealthCheckResult) String Uses

func (m HealthCheckResult) String() string

type HealthCheckResultHealthCheckStatusEnum Uses

type HealthCheckResultHealthCheckStatusEnum string

HealthCheckResultHealthCheckStatusEnum Enum with underlying type: string

const (
    HealthCheckResultHealthCheckStatusOk                HealthCheckResultHealthCheckStatusEnum = "OK"
    HealthCheckResultHealthCheckStatusInvalidStatusCode HealthCheckResultHealthCheckStatusEnum = "INVALID_STATUS_CODE"
    HealthCheckResultHealthCheckStatusTimedOut          HealthCheckResultHealthCheckStatusEnum = "TIMED_OUT"
    HealthCheckResultHealthCheckStatusRegexMismatch     HealthCheckResultHealthCheckStatusEnum = "REGEX_MISMATCH"
    HealthCheckResultHealthCheckStatusConnectFailed     HealthCheckResultHealthCheckStatusEnum = "CONNECT_FAILED"
    HealthCheckResultHealthCheckStatusIoError           HealthCheckResultHealthCheckStatusEnum = "IO_ERROR"
    HealthCheckResultHealthCheckStatusOffline           HealthCheckResultHealthCheckStatusEnum = "OFFLINE"
    HealthCheckResultHealthCheckStatusUnknown           HealthCheckResultHealthCheckStatusEnum = "UNKNOWN"
)

Set of constants representing the allowable values for HealthCheckResultHealthCheckStatusEnum

func GetHealthCheckResultHealthCheckStatusEnumValues Uses

func GetHealthCheckResultHealthCheckStatusEnumValues() []HealthCheckResultHealthCheckStatusEnum

GetHealthCheckResultHealthCheckStatusEnumValues Enumerates the set of values for HealthCheckResultHealthCheckStatusEnum

type HealthChecker Uses

type HealthChecker struct {

    // The protocol the health check must use; either HTTP or TCP.
    // Example: `HTTP`
    Protocol *string `mandatory:"true" json:"protocol"`

    // The backend server port against which to run the health check. If the port is not specified, the load balancer uses the
    // port information from the `Backend` object.
    // Example: `8080`
    Port *int `mandatory:"true" json:"port"`

    // The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol,
    // you can use common HTTP status codes such as "200".
    // Example: `200`
    ReturnCode *int `mandatory:"true" json:"returnCode"`

    // A regular expression for parsing the response body from the backend server.
    // Example: `^((?!false).|\s)*$`
    ResponseBodyRegex *string `mandatory:"true" json:"responseBodyRegex"`

    // The path against which to run the health check.
    // Example: `/healthcheck`
    UrlPath *string `mandatory:"false" json:"urlPath"`

    // The number of retries to attempt before a backend server is considered "unhealthy". This number also applies
    // when recovering a server to the "healthy" state. Defaults to 3.
    // Example: `3`
    Retries *int `mandatory:"false" json:"retries"`

    // The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply
    // returns within this timeout period. Defaults to 3000 (3 seconds).
    // Example: `3000`
    TimeoutInMillis *int `mandatory:"false" json:"timeoutInMillis"`

    // The interval between health checks, in milliseconds. The default is 10000 (10 seconds).
    // Example: `10000`
    IntervalInMillis *int `mandatory:"false" json:"intervalInMillis"`
}

HealthChecker The health check policy configuration. For more information, see Editing Health Check Policies (https://docs.cloud.oracle.com/Content/Balance/Tasks/editinghealthcheck.htm).

func (HealthChecker) String Uses

func (m HealthChecker) String() string

type HealthCheckerDetails Uses

type HealthCheckerDetails struct {

    // The protocol the health check must use; either HTTP or TCP.
    // Example: `HTTP`
    Protocol *string `mandatory:"true" json:"protocol"`

    // The path against which to run the health check.
    // Example: `/healthcheck`
    UrlPath *string `mandatory:"false" json:"urlPath"`

    // The backend server port against which to run the health check. If the port is not specified, the load balancer uses the
    // port information from the `Backend` object.
    // Example: `8080`
    Port *int `mandatory:"false" json:"port"`

    // The status code a healthy backend server should return.
    // Example: `200`
    ReturnCode *int `mandatory:"false" json:"returnCode"`

    // The number of retries to attempt before a backend server is considered "unhealthy". This number also applies
    // when recovering a server to the "healthy" state.
    // Example: `3`
    Retries *int `mandatory:"false" json:"retries"`

    // The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply
    // returns within this timeout period.
    // Example: `3000`
    TimeoutInMillis *int `mandatory:"false" json:"timeoutInMillis"`

    // The interval between health checks, in milliseconds.
    // Example: `10000`
    IntervalInMillis *int `mandatory:"false" json:"intervalInMillis"`

    // A regular expression for parsing the response body from the backend server.
    // Example: `^((?!false).|\s)*$`
    ResponseBodyRegex *string `mandatory:"false" json:"responseBodyRegex"`
}

HealthCheckerDetails The health check policy's configuration details.

func (HealthCheckerDetails) String Uses

func (m HealthCheckerDetails) String() string

type Hostname Uses

type Hostname struct {

    // A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential
    // information.
    // Example: `example_hostname_001`
    Name *string `mandatory:"true" json:"name"`

    // A virtual hostname. For more information about virtual hostname string construction, see
    // Managing Request Routing (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm#routing).
    // Example: `app.example.com`
    Hostname *string `mandatory:"true" json:"hostname"`
}

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.

func (Hostname) String Uses

func (m Hostname) String() string

type HostnameDetails Uses

type HostnameDetails struct {

    // The name of the hostname resource.
    // Example: `example_hostname_001`
    Name *string `mandatory:"true" json:"name"`

    // A virtual hostname. For more information about virtual hostname string construction, see
    // Managing Request Routing (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm#routing).
    // Example: `app.example.com`
    Hostname *string `mandatory:"true" json:"hostname"`
}

HostnameDetails The details of a hostname resource associated with a load balancer.

func (HostnameDetails) String Uses

func (m HostnameDetails) String() string

type IpAddress Uses

type IpAddress struct {

    // An IP address.
    // Example: `192.168.0.3`
    IpAddress *string `mandatory:"true" json:"ipAddress"`

    // Whether the IP address is public or private.
    // If "true", the IP address is public and accessible from the internet.
    // If "false", the IP address is private and accessible only from within the associated VCN.
    IsPublic *bool `mandatory:"false" json:"isPublic"`
}

IpAddress A load balancer IP address.

func (IpAddress) String Uses

func (m IpAddress) String() string

type LbCookieSessionPersistenceConfigurationDetails Uses

type LbCookieSessionPersistenceConfigurationDetails struct {

    // The name of the cookie inserted by the load balancer. If this field is not configured, the cookie name defaults
    // to "X-Oracle-BMC-LBS-Route".
    // Example: `example_cookie`
    // **Notes:**
    // *  Ensure that the cookie name used at the backend application servers is different from the cookie name used
    //    at the load balancer. To minimize the chance of name collision, Oracle recommends that you use a prefix
    //    such as "X-Oracle-OCI-" for this field.
    // *  If a backend server and the load balancer both insert cookies with the same name, the client or browser
    //    behavior can vary depending on the domain and path values associated with the cookie. If the name, domain,
    //    and path values of the `Set-cookie` generated by a backend server and the `Set-cookie` generated by the
    //    load balancer are all the same, the client or browser treats them as one cookie and returns only one of
    //    the cookie values in subsequent requests. If both `Set-cookie` names are the same, but the domain and path
    //    names are different, the client or browser treats them as two different cookies.
    CookieName *string `mandatory:"false" json:"cookieName"`

    // Whether the load balancer is prevented from directing traffic from a persistent session client to
    // a different backend server if the original server is unavailable. Defaults to false.
    // Example: `false`
    DisableFallback *bool `mandatory:"false" json:"disableFallback"`

    // The domain in which the cookie is valid. The `Set-cookie` header inserted by the load balancer contains a
    // domain attribute with the specified value.
    // This attribute has no default value. If you do not specify a value, the load balancer does not insert the domain
    // attribute into the `Set-cookie` header.
    // **Notes:**
    // *  RFC 6265 - HTTP State Management Mechanism (https://www.ietf.org/rfc/rfc6265.txt) describes client and
    //    browser behavior when the domain attribute is present or not present in the `Set-cookie` header.
    //    If the value of the `Domain` attribute is `example.com` in the `Set-cookie` header, the client includes
    //    the same cookie in the `Cookie` header when making HTTP requests to `example.com`, `www.example.com`, and
    //    `www.abc.example.com`. If the `Domain` attribute is not present, the client returns the cookie only for
    //    the domain to which the original request was made.
    // *  Ensure that this attribute specifies the correct domain value. If the `Domain` attribute in the `Set-cookie`
    //    header does not include the domain to which the original request was made, the client or browser might reject
    //    the cookie. As specified in RFC 6265, the client accepts a cookie with the `Domain` attribute value `example.com`
    //    or `www.example.com` sent from `www.example.com`. It does not accept a cookie with the `Domain` attribute
    //    `abc.example.com` or `www.abc.example.com` sent from `www.example.com`.
    // Example: `example.com`
    Domain *string `mandatory:"false" json:"domain"`

    // The path in which the cookie is valid. The `Set-cookie header` inserted by the load balancer contains a `Path`
    // attribute with the specified value.
    // Clients include the cookie in an HTTP request only if the path portion of the request-uri matches, or is a
    // subdirectory of, the cookie's `Path` attribute.
    // The default value is `/`.
    // Example: `/example`
    Path *string `mandatory:"false" json:"path"`

    // The amount of time the cookie remains valid. The `Set-cookie` header inserted by the load balancer contains
    // a `Max-Age` attribute with the specified value.
    // The specified value must be at least one second. There is no default value for this attribute. If you do not
    // specify a value, the load balancer does not include the `Max-Age` attribute in the `Set-cookie` header. In
    // most cases, the client or browser retains the cookie until the current session ends, as defined by the client.
    // Example: `3600`
    MaxAgeInSeconds *int `mandatory:"false" json:"maxAgeInSeconds"`

    // Whether the `Set-cookie` header should contain the `Secure` attribute. If `true`, the `Set-cookie` header
    // inserted by the load balancer contains the `Secure` attribute, which directs the client or browser to send the
    // cookie only using a secure protocol.
    // **Note:** If you set this field to `true`, you cannot associate the corresponding backend set with an HTTP
    // listener.
    // Example: `true`
    IsSecure *bool `mandatory:"false" json:"isSecure"`

    // Whether the `Set-cookie` header should contain the `HttpOnly` attribute. If `true`, the `Set-cookie` header
    // inserted by the load balancer contains the `HttpOnly` attribute, which limits the scope of the cookie to HTTP
    // requests. This attribute directs the client or browser to omit the cookie when providing access to cookies
    // through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels.
    // Example: `true`
    IsHttpOnly *bool `mandatory:"false" json:"isHttpOnly"`
}

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 (https://docs.cloud.oracle.com/Content/Balance/Reference/sessionpersistence.htm). 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 UpdateBackendSet operation and specify `null` for the `LBCookieSessionPersistenceConfigurationDetails` object. Example: `LBCookieSessionPersistenceConfigurationDetails: null` **Note:** `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.

func (LbCookieSessionPersistenceConfigurationDetails) String Uses

func (m LbCookieSessionPersistenceConfigurationDetails) String() string

type ListBackendSetsRequest Uses

type ListBackendSetsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend sets to retrieve.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListBackendSetsRequest wrapper for the ListBackendSets operation

func (ListBackendSetsRequest) HTTPRequest Uses

func (request ListBackendSetsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBackendSetsRequest) RetryPolicy Uses

func (request ListBackendSetsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBackendSetsRequest) String Uses

func (request ListBackendSetsRequest) String() string

type ListBackendSetsResponse Uses

type ListBackendSetsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The []BackendSet instance
    Items []BackendSet `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListBackendSetsResponse wrapper for the ListBackendSets operation

func (ListBackendSetsResponse) HTTPResponse Uses

func (response ListBackendSetsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBackendSetsResponse) String Uses

func (response ListBackendSetsResponse) String() string

type ListBackendsRequest Uses

type ListBackendsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and servers.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the backend set associated with the backend servers.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListBackendsRequest wrapper for the ListBackends operation

func (ListBackendsRequest) HTTPRequest Uses

func (request ListBackendsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBackendsRequest) RetryPolicy Uses

func (request ListBackendsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBackendsRequest) String Uses

func (request ListBackendsRequest) String() string

type ListBackendsResponse Uses

type ListBackendsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The []Backend instance
    Items []Backend `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListBackendsResponse wrapper for the ListBackends operation

func (ListBackendsResponse) HTTPResponse Uses

func (response ListBackendsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBackendsResponse) String Uses

func (response ListBackendsResponse) String() string

type ListCertificatesRequest Uses

type ListCertificatesRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the certificate bundles
    // to be listed.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListCertificatesRequest wrapper for the ListCertificates operation

func (ListCertificatesRequest) HTTPRequest Uses

func (request ListCertificatesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListCertificatesRequest) RetryPolicy Uses

func (request ListCertificatesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListCertificatesRequest) String Uses

func (request ListCertificatesRequest) String() string

type ListCertificatesResponse Uses

type ListCertificatesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The []Certificate instance
    Items []Certificate `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListCertificatesResponse wrapper for the ListCertificates operation

func (ListCertificatesResponse) HTTPResponse Uses

func (response ListCertificatesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListCertificatesResponse) String Uses

func (response ListCertificatesResponse) String() string

type ListHostnamesRequest Uses

type ListHostnamesRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the hostnames
    // to retrieve.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListHostnamesRequest wrapper for the ListHostnames operation

func (ListHostnamesRequest) HTTPRequest Uses

func (request ListHostnamesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListHostnamesRequest) RetryPolicy Uses

func (request ListHostnamesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListHostnamesRequest) String Uses

func (request ListHostnamesRequest) String() string

type ListHostnamesResponse Uses

type ListHostnamesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The []Hostname instance
    Items []Hostname `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListHostnamesResponse wrapper for the ListHostnames operation

func (ListHostnamesResponse) HTTPResponse Uses

func (response ListHostnamesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListHostnamesResponse) String Uses

func (response ListHostnamesResponse) String() string

type ListListenerRulesRequest Uses

type ListListenerRulesRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the listener the rules are associated with.
    ListenerName *string `mandatory:"true" contributesTo:"path" name:"listenerName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListListenerRulesRequest wrapper for the ListListenerRules operation

func (ListListenerRulesRequest) HTTPRequest Uses

func (request ListListenerRulesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListListenerRulesRequest) RetryPolicy Uses

func (request ListListenerRulesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListListenerRulesRequest) String Uses

func (request ListListenerRulesRequest) String() string

type ListListenerRulesResponse Uses

type ListListenerRulesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The []ListenerRuleSummary instance
    Items []ListenerRuleSummary `presentIn:"body"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListListenerRulesResponse wrapper for the ListListenerRules operation

func (ListListenerRulesResponse) HTTPResponse Uses

func (response ListListenerRulesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListListenerRulesResponse) String Uses

func (response ListListenerRulesResponse) String() string

type ListLoadBalancerHealthsRequest Uses

type ListLoadBalancerHealthsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancers to return health status information for.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `50`
    Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response header from the previous "List" call.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `3`
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListLoadBalancerHealthsRequest wrapper for the ListLoadBalancerHealths operation

func (ListLoadBalancerHealthsRequest) HTTPRequest Uses

func (request ListLoadBalancerHealthsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListLoadBalancerHealthsRequest) RetryPolicy Uses

func (request ListLoadBalancerHealthsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListLoadBalancerHealthsRequest) String Uses

func (request ListLoadBalancerHealthsRequest) String() string

type ListLoadBalancerHealthsResponse Uses

type ListLoadBalancerHealthsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []LoadBalancerHealthSummary instances
    Items []LoadBalancerHealthSummary `presentIn:"body"`

    // For list pagination. When this header appears in the response, additional pages of results remain.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListLoadBalancerHealthsResponse wrapper for the ListLoadBalancerHealths operation

func (ListLoadBalancerHealthsResponse) HTTPResponse Uses

func (response ListLoadBalancerHealthsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListLoadBalancerHealthsResponse) String Uses

func (response ListLoadBalancerHealthsResponse) String() string

type ListLoadBalancersRequest Uses

type ListLoadBalancersRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancers to list.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `50`
    Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response header from the previous "List" call.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `3`
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The level of detail to return for each result. Can be `full` or `simple`.
    // Example: `full`
    Detail *string `mandatory:"false" contributesTo:"query" name:"detail"`

    // The field to sort by.  You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending.
    // Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
    SortBy ListLoadBalancersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.
    SortOrder ListLoadBalancersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // A filter to return only resources that match the given display name exactly.
    // Example: `example_load_balancer`
    DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

    // A filter to return only resources that match the given lifecycle state.
    // Example: `SUCCEEDED`
    LifecycleState LoadBalancerLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListLoadBalancersRequest wrapper for the ListLoadBalancers operation

func (ListLoadBalancersRequest) HTTPRequest Uses

func (request ListLoadBalancersRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListLoadBalancersRequest) RetryPolicy Uses

func (request ListLoadBalancersRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListLoadBalancersRequest) String Uses

func (request ListLoadBalancersRequest) String() string

type ListLoadBalancersResponse Uses

type ListLoadBalancersResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []LoadBalancer instances
    Items []LoadBalancer `presentIn:"body"`

    // For list pagination. When this header appears in the response, additional pages of results remain.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListLoadBalancersResponse wrapper for the ListLoadBalancers operation

func (ListLoadBalancersResponse) HTTPResponse Uses

func (response ListLoadBalancersResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListLoadBalancersResponse) String Uses

func (response ListLoadBalancersResponse) String() string

type ListLoadBalancersSortByEnum Uses

type ListLoadBalancersSortByEnum string

ListLoadBalancersSortByEnum Enum with underlying type: string

const (
    ListLoadBalancersSortByTimecreated ListLoadBalancersSortByEnum = "TIMECREATED"
    ListLoadBalancersSortByDisplayname ListLoadBalancersSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListLoadBalancersSortByEnum

func GetListLoadBalancersSortByEnumValues Uses

func GetListLoadBalancersSortByEnumValues() []ListLoadBalancersSortByEnum

GetListLoadBalancersSortByEnumValues Enumerates the set of values for ListLoadBalancersSortByEnum

type ListLoadBalancersSortOrderEnum Uses

type ListLoadBalancersSortOrderEnum string

ListLoadBalancersSortOrderEnum Enum with underlying type: string

const (
    ListLoadBalancersSortOrderAsc  ListLoadBalancersSortOrderEnum = "ASC"
    ListLoadBalancersSortOrderDesc ListLoadBalancersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListLoadBalancersSortOrderEnum

func GetListLoadBalancersSortOrderEnumValues Uses

func GetListLoadBalancersSortOrderEnumValues() []ListLoadBalancersSortOrderEnum

GetListLoadBalancersSortOrderEnumValues Enumerates the set of values for ListLoadBalancersSortOrderEnum

type ListPathRouteSetsRequest Uses

type ListPathRouteSetsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route sets
    // to retrieve.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListPathRouteSetsRequest wrapper for the ListPathRouteSets operation

func (ListPathRouteSetsRequest) HTTPRequest Uses

func (request ListPathRouteSetsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListPathRouteSetsRequest) RetryPolicy Uses

func (request ListPathRouteSetsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListPathRouteSetsRequest) String Uses

func (request ListPathRouteSetsRequest) String() string

type ListPathRouteSetsResponse Uses

type ListPathRouteSetsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The []PathRouteSet instance
    Items []PathRouteSet `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListPathRouteSetsResponse wrapper for the ListPathRouteSets operation

func (ListPathRouteSetsResponse) HTTPResponse Uses

func (response ListPathRouteSetsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListPathRouteSetsResponse) String Uses

func (response ListPathRouteSetsResponse) String() string

type ListPoliciesRequest Uses

type ListPoliciesRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer policies to list.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `50`
    Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response header from the previous "List" call.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `3`
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListPoliciesRequest wrapper for the ListPolicies operation

func (ListPoliciesRequest) HTTPRequest Uses

func (request ListPoliciesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListPoliciesRequest) RetryPolicy Uses

func (request ListPoliciesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListPoliciesRequest) String Uses

func (request ListPoliciesRequest) String() string

type ListPoliciesResponse Uses

type ListPoliciesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []LoadBalancerPolicy instances
    Items []LoadBalancerPolicy `presentIn:"body"`

    // For list pagination. When this header appears in the response, additional pages of results remain.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListPoliciesResponse wrapper for the ListPolicies operation

func (ListPoliciesResponse) HTTPResponse Uses

func (response ListPoliciesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListPoliciesResponse) String Uses

func (response ListPoliciesResponse) String() string

type ListProtocolsRequest Uses

type ListProtocolsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer protocols to list.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `50`
    Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response header from the previous "List" call.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `3`
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListProtocolsRequest wrapper for the ListProtocols operation

func (ListProtocolsRequest) HTTPRequest Uses

func (request ListProtocolsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListProtocolsRequest) RetryPolicy Uses

func (request ListProtocolsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListProtocolsRequest) String Uses

func (request ListProtocolsRequest) String() string

type ListProtocolsResponse Uses

type ListProtocolsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []LoadBalancerProtocol instances
    Items []LoadBalancerProtocol `presentIn:"body"`

    // For list pagination. When this header appears in the response, additional pages of results remain.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListProtocolsResponse wrapper for the ListProtocols operation

func (ListProtocolsResponse) HTTPResponse Uses

func (response ListProtocolsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListProtocolsResponse) String Uses

func (response ListProtocolsResponse) String() string

type ListRuleSetsRequest Uses

type ListRuleSetsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the specified load balancer.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListRuleSetsRequest wrapper for the ListRuleSets operation

func (ListRuleSetsRequest) HTTPRequest Uses

func (request ListRuleSetsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListRuleSetsRequest) RetryPolicy Uses

func (request ListRuleSetsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListRuleSetsRequest) String Uses

func (request ListRuleSetsRequest) String() string

type ListRuleSetsResponse Uses

type ListRuleSetsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The []RuleSet instance
    Items []RuleSet `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListRuleSetsResponse wrapper for the ListRuleSets operation

func (ListRuleSetsResponse) HTTPResponse Uses

func (response ListRuleSetsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListRuleSetsResponse) String Uses

func (response ListRuleSetsResponse) String() string

type ListShapesRequest Uses

type ListShapesRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer shapes to list.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `50`
    Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response header from the previous "List" call.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `3`
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListShapesRequest wrapper for the ListShapes operation

func (ListShapesRequest) HTTPRequest Uses

func (request ListShapesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListShapesRequest) RetryPolicy Uses

func (request ListShapesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListShapesRequest) String Uses

func (request ListShapesRequest) String() string

type ListShapesResponse Uses

type ListShapesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []LoadBalancerShape instances
    Items []LoadBalancerShape `presentIn:"body"`

    // For list pagination. When this header appears in the response, additional pages of results remain.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListShapesResponse wrapper for the ListShapes operation

func (ListShapesResponse) HTTPResponse Uses

func (response ListShapesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListShapesResponse) String Uses

func (response ListShapesResponse) String() string

type ListWorkRequestsRequest Uses

type ListWorkRequestsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the work requests to retrieve.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `50`
    Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response header from the previous "List" call.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    // Example: `3`
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

func (ListWorkRequestsRequest) HTTPRequest Uses

func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy Uses

func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestsRequest) String Uses

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResponse Uses

type ListWorkRequestsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []WorkRequest instances
    Items []WorkRequest `presentIn:"body"`

    // For list pagination. When this header appears in the response, additional pages of results remain.
    // For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse Uses

func (response ListWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String Uses

func (response ListWorkRequestsResponse) String() string

type Listener Uses

type Listener struct {

    // A friendly name for the listener. It must be unique and it cannot be changed.
    // Example: `example_listener`
    Name *string `mandatory:"true" json:"name"`

    // The name of the associated backend set.
    // Example: `example_backend_set`
    DefaultBackendSetName *string `mandatory:"true" json:"defaultBackendSetName"`

    // The communication port for the listener.
    // Example: `80`
    Port *int `mandatory:"true" json:"port"`

    // The protocol on which the listener accepts connection requests.
    // To get a list of valid protocols, use the ListProtocols
    // operation.
    // Example: `HTTP`
    Protocol *string `mandatory:"true" json:"protocol"`

    // An array of hostname resource names.
    HostnameNames []string `mandatory:"false" json:"hostnameNames"`

    // The name of the set of path-based routing rules, PathRouteSet,
    // applied to this listener's traffic.
    // Example: `example_path_route_set`
    PathRouteSetName *string `mandatory:"false" json:"pathRouteSetName"`

    SslConfiguration *SslConfiguration `mandatory:"false" json:"sslConfiguration"`

    ConnectionConfiguration *ConnectionConfiguration `mandatory:"false" json:"connectionConfiguration"`

    // The names of the RuleSet to apply to the listener.
    // Example: ["example_rule_set"]
    RuleSetNames []string `mandatory:"false" json:"ruleSetNames"`
}

Listener The listener's configuration. For more information on backend set configuration, see Managing Load Balancer Listeners (https://docs.cloud.oracle.com/Content/Balance/Tasks/managinglisteners.htm).

func (Listener) String Uses

func (m Listener) String() string

type ListenerDetails Uses

type ListenerDetails struct {

    // The name of the associated backend set.
    // Example: `example_backend_set`
    DefaultBackendSetName *string `mandatory:"true" json:"defaultBackendSetName"`

    // The communication port for the listener.
    // Example: `80`
    Port *int `mandatory:"true" json:"port"`

    // The protocol on which the listener accepts connection requests.
    // To get a list of valid protocols, use the ListProtocols
    // operation.
    // Example: `HTTP`
    Protocol *string `mandatory:"true" json:"protocol"`

    // An array of hostname resource names.
    HostnameNames []string `mandatory:"false" json:"hostnameNames"`

    // The name of the set of path-based routing rules, PathRouteSet,
    // applied to this listener's traffic.
    // Example: `example_path_route_set`
    PathRouteSetName *string `mandatory:"false" json:"pathRouteSetName"`

    SslConfiguration *SslConfigurationDetails `mandatory:"false" json:"sslConfiguration"`

    ConnectionConfiguration *ConnectionConfiguration `mandatory:"false" json:"connectionConfiguration"`

    // The names of the RuleSet to apply to the listener.
    //  Example: ["example_rule_set"]
    RuleSetNames []string `mandatory:"false" json:"ruleSetNames"`
}

ListenerDetails The listener's configuration details.

func (ListenerDetails) String Uses

func (m ListenerDetails) String() string

type ListenerRuleSummary Uses

type ListenerRuleSummary struct {

    // A rule object that applies to the listener.
    Rule Rule `mandatory:"false" json:"rule"`

    // The name of the rule set that the rule belongs to.
    RuleSetName *string `mandatory:"false" json:"ruleSetName"`
}

ListenerRuleSummary The attributes of a rule associated with the specified listener, and the name of the rule set that the rule belongs to.

func (ListenerRuleSummary) String Uses

func (m ListenerRuleSummary) String() string

func (*ListenerRuleSummary) UnmarshalJSON Uses

func (m *ListenerRuleSummary) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type LoadBalancer Uses

type LoadBalancer struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer.
    Id  *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A user-friendly name. It does not have to be unique, and it is changeable.
    // Example: `example_load_balancer`
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The current state of the load balancer.
    LifecycleState LoadBalancerLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The date and time the load balancer was created, in the format defined by RFC3339.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // A template that determines the total pre-provisioned bandwidth (ingress plus egress).
    // To get a list of available shapes, use the ListShapes
    // operation.
    // Example: `100Mbps`
    ShapeName *string `mandatory:"true" json:"shapeName"`

    // An array of IP addresses.
    IpAddresses []IpAddress `mandatory:"false" json:"ipAddresses"`

    // Whether the load balancer has a VCN-local (private) IP address.
    // If "true", the service assigns a private IP address to the load balancer.
    // If "false", the service assigns a public IP address to the load balancer.
    // A public load balancer is accessible from the internet, depending on your VCN's
    // security list rules (https://docs.cloud.oracle.com/Content/Network/Concepts/securitylists.htm). For more information about public and
    // private load balancers, see How Load Balancing Works (https://docs.cloud.oracle.com/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works).
    // Example: `true`
    IsPrivate *bool `mandatory:"false" json:"isPrivate"`

    // An array of subnet OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
    SubnetIds []string `mandatory:"false" json:"subnetIds"`

    // An array of NSG OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with the load
    // balancer.
    // During the load balancer's creation, the service adds the new load balancer to the specified NSGs.
    // The benefits of associating the load balancer with NSGs include:
    // *  NSGs define network security rules to govern ingress and egress traffic for the load balancer.
    // *  The network security rules of other resources can reference the NSGs associated with the load balancer
    //    to ensure access.
    // Example: ["ocid1.nsg.oc1.phx.unique_ID"]
    NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`

    Listeners map[string]Listener `mandatory:"false" json:"listeners"`

    Hostnames map[string]Hostname `mandatory:"false" json:"hostnames"`

    Certificates map[string]Certificate `mandatory:"false" json:"certificates"`

    BackendSets map[string]BackendSet `mandatory:"false" json:"backendSets"`

    PathRouteSets map[string]PathRouteSet `mandatory:"false" json:"pathRouteSets"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // System tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // System tags can be viewed by users, but can only be created by the system.
    // Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`

    RuleSets map[string]RuleSet `mandatory:"false" json:"ruleSets"`
}

LoadBalancer The properties that define a load balancer. For more information, see Managing a Load Balancer (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingloadbalancer.htm). 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 (https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm). For information about endpoints and signing API requests, see About the API (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see SDKS and Other Tools (https://docs.cloud.oracle.com/Content/API/Concepts/sdks.htm).

func (LoadBalancer) String Uses

func (m LoadBalancer) String() string

type LoadBalancerClient Uses

type LoadBalancerClient struct {
    common.BaseClient
    // contains filtered or unexported fields
}

LoadBalancerClient a client for LoadBalancer

func NewLoadBalancerClientWithConfigurationProvider Uses

func NewLoadBalancerClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client LoadBalancerClient, err error)

NewLoadBalancerClientWithConfigurationProvider Creates a new default LoadBalancer client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewLoadBalancerClientWithOboToken Uses

func NewLoadBalancerClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client LoadBalancerClient, err error)

NewLoadBalancerClientWithOboToken Creates a new default LoadBalancer client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (LoadBalancerClient) ChangeLoadBalancerCompartment Uses

func (client LoadBalancerClient) ChangeLoadBalancerCompartment(ctx context.Context, request ChangeLoadBalancerCompartmentRequest) (response ChangeLoadBalancerCompartmentResponse, err error)

ChangeLoadBalancerCompartment Moves a load balancer into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

func (*LoadBalancerClient) ConfigurationProvider Uses

func (client *LoadBalancerClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (LoadBalancerClient) CreateBackend Uses

func (client LoadBalancerClient) CreateBackend(ctx context.Context, request CreateBackendRequest) (response CreateBackendResponse, err error)

CreateBackend Adds a backend server to a backend set.

func (LoadBalancerClient) CreateBackendSet Uses

func (client LoadBalancerClient) CreateBackendSet(ctx context.Context, request CreateBackendSetRequest) (response CreateBackendSetResponse, err error)

CreateBackendSet Adds a backend set to a load balancer.

func (LoadBalancerClient) CreateCertificate Uses

func (client LoadBalancerClient) CreateCertificate(ctx context.Context, request CreateCertificateRequest) (response CreateCertificateResponse, err error)

CreateCertificate Creates an asynchronous request to add an SSL certificate bundle.

func (LoadBalancerClient) CreateHostname Uses

func (client LoadBalancerClient) CreateHostname(ctx context.Context, request CreateHostnameRequest) (response CreateHostnameResponse, err error)

CreateHostname Adds a hostname resource to the specified load balancer. For more information, see Managing Request Routing (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm).

func (LoadBalancerClient) CreateListener Uses

func (client LoadBalancerClient) CreateListener(ctx context.Context, request CreateListenerRequest) (response CreateListenerResponse, err error)

CreateListener Adds a listener to a load balancer.

func (LoadBalancerClient) CreateLoadBalancer Uses

func (client LoadBalancerClient) CreateLoadBalancer(ctx context.Context, request CreateLoadBalancerRequest) (response CreateLoadBalancerResponse, err error)

CreateLoadBalancer Creates a new load balancer in the specified compartment. For general information about load balancers, see Overview of the Load Balancing Service (https://docs.cloud.oracle.com/Content/Balance/Concepts/balanceoverview.htm). For the purposes of access control, you must provide the OCID of the compartment where you want the load balancer to reside. Notice that the load balancer doesn't have to be in the same compartment as the VCN or backend set. If you're not sure which compartment to use, put the load balancer in the same compartment as the VCN. For information about access control and compartments, see Overview of the IAM Service (https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm). You must specify a display name for the load balancer. It does not have to be unique, and you can change it. For information about Availability Domains, see Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm). To get a list of Availability Domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure resources, including load balancers, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. Fore more information, see Resource Identifiers (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). After you send your request, the new object's state will temporarily be PROVISIONING. Before using the object, first make sure its state has changed to RUNNING. When you create a load balancer, the system assigns an IP address. To get the IP address, use the GetLoadBalancer operation.

func (LoadBalancerClient) CreatePathRouteSet Uses

func (client LoadBalancerClient) CreatePathRouteSet(ctx context.Context, request CreatePathRouteSetRequest) (response CreatePathRouteSetResponse, err error)

CreatePathRouteSet Adds a path route set to a load balancer. For more information, see Managing Request Routing (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm).

func (LoadBalancerClient) CreateRuleSet Uses

func (client LoadBalancerClient) CreateRuleSet(ctx context.Context, request CreateRuleSetRequest) (response CreateRuleSetResponse, err error)

CreateRuleSet Creates a new rule set associated with the specified load balancer. For more information, see Managing Rule Sets (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrulesets.htm).

func (LoadBalancerClient) DeleteBackend Uses

func (client LoadBalancerClient) DeleteBackend(ctx context.Context, request DeleteBackendRequest) (response DeleteBackendResponse, err error)

DeleteBackend Removes a backend server from a given load balancer and backend set.

func (LoadBalancerClient) DeleteBackendSet Uses

func (client LoadBalancerClient) DeleteBackendSet(ctx context.Context, request DeleteBackendSetRequest) (response DeleteBackendSetResponse, err error)

DeleteBackendSet Deletes the specified backend set. Note that deleting a backend set removes its backend servers from the load balancer. Before you can delete a backend set, you must remove it from any active listeners.

func (LoadBalancerClient) DeleteCertificate Uses

func (client LoadBalancerClient) DeleteCertificate(ctx context.Context, request DeleteCertificateRequest) (response DeleteCertificateResponse, err error)

DeleteCertificate Deletes an SSL certificate bundle from a load balancer.

func (LoadBalancerClient) DeleteHostname Uses

func (client LoadBalancerClient) DeleteHostname(ctx context.Context, request DeleteHostnameRequest) (response DeleteHostnameResponse, err error)

DeleteHostname Deletes a hostname resource from the specified load balancer.

func (LoadBalancerClient) DeleteListener Uses

func (client LoadBalancerClient) DeleteListener(ctx context.Context, request DeleteListenerRequest) (response DeleteListenerResponse, err error)

DeleteListener Deletes a listener from a load balancer.

func (LoadBalancerClient) DeleteLoadBalancer Uses

func (client LoadBalancerClient) DeleteLoadBalancer(ctx context.Context, request DeleteLoadBalancerRequest) (response DeleteLoadBalancerResponse, err error)

DeleteLoadBalancer Stops a load balancer and removes it from service.

func (LoadBalancerClient) DeletePathRouteSet Uses

func (client LoadBalancerClient) DeletePathRouteSet(ctx context.Context, request DeletePathRouteSetRequest) (response DeletePathRouteSetResponse, err error)

DeletePathRouteSet Deletes a path route set from the specified load balancer. To delete a path route rule from a path route set, use the UpdatePathRouteSet operation.

func (LoadBalancerClient) DeleteRuleSet Uses

func (client LoadBalancerClient) DeleteRuleSet(ctx context.Context, request DeleteRuleSetRequest) (response DeleteRuleSetResponse, err error)

DeleteRuleSet Deletes a rule set from the specified load balancer. To delete a rule from a rule set, use the UpdateRuleSet operation.

func (LoadBalancerClient) GetBackend Uses

func (client LoadBalancerClient) GetBackend(ctx context.Context, request GetBackendRequest) (response GetBackendResponse, err error)

GetBackend Gets the specified backend server's configuration information.

func (LoadBalancerClient) GetBackendHealth Uses

func (client LoadBalancerClient) GetBackendHealth(ctx context.Context, request GetBackendHealthRequest) (response GetBackendHealthResponse, err error)

GetBackendHealth Gets the current health status of the specified backend server.

func (LoadBalancerClient) GetBackendSet Uses

func (client LoadBalancerClient) GetBackendSet(ctx context.Context, request GetBackendSetRequest) (response GetBackendSetResponse, err error)

GetBackendSet Gets the specified backend set's configuration information.

func (LoadBalancerClient) GetBackendSetHealth Uses

func (client LoadBalancerClient) GetBackendSetHealth(ctx context.Context, request GetBackendSetHealthRequest) (response GetBackendSetHealthResponse, err error)

GetBackendSetHealth Gets the health status for the specified backend set.

func (LoadBalancerClient) GetHealthChecker Uses

func (client LoadBalancerClient) GetHealthChecker(ctx context.Context, request GetHealthCheckerRequest) (response GetHealthCheckerResponse, err error)

GetHealthChecker Gets the health check policy information for a given load balancer and backend set.

func (LoadBalancerClient) GetHostname Uses

func (client LoadBalancerClient) GetHostname(ctx context.Context, request GetHostnameRequest) (response GetHostnameResponse, err error)

GetHostname Gets the specified hostname resource's configuration information.

func (LoadBalancerClient) GetLoadBalancer Uses

func (client LoadBalancerClient) GetLoadBalancer(ctx context.Context, request GetLoadBalancerRequest) (response GetLoadBalancerResponse, err error)

GetLoadBalancer Gets the specified load balancer's configuration information.

func (LoadBalancerClient) GetLoadBalancerHealth Uses

func (client LoadBalancerClient) GetLoadBalancerHealth(ctx context.Context, request GetLoadBalancerHealthRequest) (response GetLoadBalancerHealthResponse, err error)

GetLoadBalancerHealth Gets the health status for the specified load balancer.

func (LoadBalancerClient) GetPathRouteSet Uses

func (client LoadBalancerClient) GetPathRouteSet(ctx context.Context, request GetPathRouteSetRequest) (response GetPathRouteSetResponse, err error)

GetPathRouteSet Gets the specified path route set's configuration information.

func (LoadBalancerClient) GetRuleSet Uses

func (client LoadBalancerClient) GetRuleSet(ctx context.Context, request GetRuleSetRequest) (response GetRuleSetResponse, err error)

GetRuleSet Gets the specified set of rules.

func (LoadBalancerClient) GetWorkRequest Uses

func (client LoadBalancerClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Gets the details of a work request.

func (LoadBalancerClient) ListBackendSets Uses

func (client LoadBalancerClient) ListBackendSets(ctx context.Context, request ListBackendSetsRequest) (response ListBackendSetsResponse, err error)

ListBackendSets Lists all backend sets associated with a given load balancer.

func (LoadBalancerClient) ListBackends Uses

func (client LoadBalancerClient) ListBackends(ctx context.Context, request ListBackendsRequest) (response ListBackendsResponse, err error)

ListBackends Lists the backend servers for a given load balancer and backend set.

func (LoadBalancerClient) ListCertificates Uses

func (client LoadBalancerClient) ListCertificates(ctx context.Context, request ListCertificatesRequest) (response ListCertificatesResponse, err error)

ListCertificates Lists all SSL certificates bundles associated with a given load balancer.

func (LoadBalancerClient) ListHostnames Uses

func (client LoadBalancerClient) ListHostnames(ctx context.Context, request ListHostnamesRequest) (response ListHostnamesResponse, err error)

ListHostnames Lists all hostname resources associated with the specified load balancer.

func (LoadBalancerClient) ListListenerRules Uses

func (client LoadBalancerClient) ListListenerRules(ctx context.Context, request ListListenerRulesRequest) (response ListListenerRulesResponse, err error)

ListListenerRules Lists all of the rules from all of the rule sets associated with the specified listener. The response organizes the rules in the following order: * Access control rules * Allow method rules * Request header rules * Response header rules

func (LoadBalancerClient) ListLoadBalancerHealths Uses

func (client LoadBalancerClient) ListLoadBalancerHealths(ctx context.Context, request ListLoadBalancerHealthsRequest) (response ListLoadBalancerHealthsResponse, err error)

ListLoadBalancerHealths Lists the summary health statuses for all load balancers in the specified compartment.

func (LoadBalancerClient) ListLoadBalancers Uses

func (client LoadBalancerClient) ListLoadBalancers(ctx context.Context, request ListLoadBalancersRequest) (response ListLoadBalancersResponse, err error)

ListLoadBalancers Lists all load balancers in the specified compartment.

func (LoadBalancerClient) ListPathRouteSets Uses

func (client LoadBalancerClient) ListPathRouteSets(ctx context.Context, request ListPathRouteSetsRequest) (response ListPathRouteSetsResponse, err error)

ListPathRouteSets Lists all path route sets associated with the specified load balancer.

func (LoadBalancerClient) ListPolicies Uses

func (client LoadBalancerClient) ListPolicies(ctx context.Context, request ListPoliciesRequest) (response ListPoliciesResponse, err error)

ListPolicies Lists the available load balancer policies.

func (LoadBalancerClient) ListProtocols Uses

func (client LoadBalancerClient) ListProtocols(ctx context.Context, request ListProtocolsRequest) (response ListProtocolsResponse, err error)

ListProtocols Lists all supported traffic protocols.

func (LoadBalancerClient) ListRuleSets Uses

func (client LoadBalancerClient) ListRuleSets(ctx context.Context, request ListRuleSetsRequest) (response ListRuleSetsResponse, err error)

ListRuleSets Lists all rule sets associated with the specified load balancer.

func (LoadBalancerClient) ListShapes Uses

func (client LoadBalancerClient) ListShapes(ctx context.Context, request ListShapesRequest) (response ListShapesResponse, err error)

ListShapes Lists the valid load balancer shapes.

func (LoadBalancerClient) ListWorkRequests Uses

func (client LoadBalancerClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Lists the work requests for a given load balancer.

func (*LoadBalancerClient) SetRegion Uses

func (client *LoadBalancerClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (LoadBalancerClient) UpdateBackend Uses

func (client LoadBalancerClient) UpdateBackend(ctx context.Context, request UpdateBackendRequest) (response UpdateBackendResponse, err error)

UpdateBackend Updates the configuration of a backend server within the specified backend set.

func (LoadBalancerClient) UpdateBackendSet Uses

func (client LoadBalancerClient) UpdateBackendSet(ctx context.Context, request UpdateBackendSetRequest) (response UpdateBackendSetResponse, err error)

UpdateBackendSet Updates a backend set.

func (LoadBalancerClient) UpdateHealthChecker Uses

func (client LoadBalancerClient) UpdateHealthChecker(ctx context.Context, request UpdateHealthCheckerRequest) (response UpdateHealthCheckerResponse, err error)

UpdateHealthChecker Updates the health check policy for a given load balancer and backend set.

func (LoadBalancerClient) UpdateHostname Uses

func (client LoadBalancerClient) UpdateHostname(ctx context.Context, request UpdateHostnameRequest) (response UpdateHostnameResponse, err error)

UpdateHostname Overwrites an existing hostname resource on the specified load balancer. Use this operation to change a virtual hostname.

func (LoadBalancerClient) UpdateListener Uses

func (client LoadBalancerClient) UpdateListener(ctx context.Context, request UpdateListenerRequest) (response UpdateListenerResponse, err error)

UpdateListener Updates a listener for a given load balancer.

func (LoadBalancerClient) UpdateLoadBalancer Uses

func (client LoadBalancerClient) UpdateLoadBalancer(ctx context.Context, request UpdateLoadBalancerRequest) (response UpdateLoadBalancerResponse, err error)

UpdateLoadBalancer Updates a load balancer's configuration.

func (LoadBalancerClient) UpdateNetworkSecurityGroups Uses

func (client LoadBalancerClient) UpdateNetworkSecurityGroups(ctx context.Context, request UpdateNetworkSecurityGroupsRequest) (response UpdateNetworkSecurityGroupsResponse, err error)

UpdateNetworkSecurityGroups Updates the network security groups associated with the specified load balancer.

func (LoadBalancerClient) UpdatePathRouteSet Uses

func (client LoadBalancerClient) UpdatePathRouteSet(ctx context.Context, request UpdatePathRouteSetRequest) (response UpdatePathRouteSetResponse, err error)

UpdatePathRouteSet Overwrites an existing path route set on the specified load balancer. Use this operation to add, delete, or alter path route rules in a path route set. To add a new path route rule to a path route set, the `pathRoutes` in the UpdatePathRouteSetDetails object must include both the new path route rule to add and the existing path route rules to retain.

func (LoadBalancerClient) UpdateRuleSet Uses

func (client LoadBalancerClient) UpdateRuleSet(ctx context.Context, request UpdateRuleSetRequest) (response UpdateRuleSetResponse, err error)

UpdateRuleSet Overwrites an existing set of rules on the specified load balancer. Use this operation to add or alter the rules in a rule set. To add a new rule to a set, the body must include both the new rule to add and the existing rules to retain.

type LoadBalancerHealth Uses

type LoadBalancerHealth struct {

    // The overall health status of the load balancer.
    // *  **OK:** All backend sets associated with the load balancer return a status of `OK`.
    // *  **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`,
    // no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.
    // *  **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`.
    // *  **UNKNOWN:** If any one of the following conditions is true:
    //     *  The load balancer life cycle state is not `ACTIVE`.
    //     *  No backend sets are defined for the load balancer.
    //     *  More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend
    //        sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.
    //     *  The system could not retrieve metrics for any reason.
    Status LoadBalancerHealthStatusEnum `mandatory:"true" json:"status"`

    // A list of backend sets that are currently in the `WARNING` health state. The list identifies each backend set by the
    // friendly name you assigned when you created it.
    // Example: `example_backend_set3`
    WarningStateBackendSetNames []string `mandatory:"true" json:"warningStateBackendSetNames"`

    // A list of backend sets that are currently in the `CRITICAL` health state. The list identifies each backend set by the
    // friendly name you assigned when you created it.
    // Example: `example_backend_set`
    CriticalStateBackendSetNames []string `mandatory:"true" json:"criticalStateBackendSetNames"`

    // A list of backend sets that are currently in the `UNKNOWN` health state. The list identifies each backend set by the
    // friendly name you assigned when you created it.
    // Example: `example_backend_set2`
    UnknownStateBackendSetNames []string `mandatory:"true" json:"unknownStateBackendSetNames"`

    // The total number of backend sets associated with this load balancer.
    // Example: `4`
    TotalBackendSetCount *int `mandatory:"true" json:"totalBackendSetCount"`
}

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.

func (LoadBalancerHealth) String Uses

func (m LoadBalancerHealth) String() string

type LoadBalancerHealthStatusEnum Uses

type LoadBalancerHealthStatusEnum string

LoadBalancerHealthStatusEnum Enum with underlying type: string

const (
    LoadBalancerHealthStatusOk       LoadBalancerHealthStatusEnum = "OK"
    LoadBalancerHealthStatusWarning  LoadBalancerHealthStatusEnum = "WARNING"
    LoadBalancerHealthStatusCritical LoadBalancerHealthStatusEnum = "CRITICAL"
    LoadBalancerHealthStatusUnknown  LoadBalancerHealthStatusEnum = "UNKNOWN"
)

Set of constants representing the allowable values for LoadBalancerHealthStatusEnum

func GetLoadBalancerHealthStatusEnumValues Uses

func GetLoadBalancerHealthStatusEnumValues() []LoadBalancerHealthStatusEnum

GetLoadBalancerHealthStatusEnumValues Enumerates the set of values for LoadBalancerHealthStatusEnum

type LoadBalancerHealthSummary Uses

type LoadBalancerHealthSummary struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer the health status is associated with.
    LoadBalancerId *string `mandatory:"true" json:"loadBalancerId"`

    // The overall health status of the load balancer.
    // *  **OK:** All backend sets associated with the load balancer return a status of `OK`.
    // *  **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`,
    // no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.
    // *  **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`.
    // *  **UNKNOWN:** If any one of the following conditions is true:
    //     *  The load balancer life cycle state is not `ACTIVE`.
    //     *  No backend sets are defined for the load balancer.
    //     *  More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend
    //        sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.
    //     *  The system could not retrieve metrics for any reason.
    Status LoadBalancerHealthSummaryStatusEnum `mandatory:"true" json:"status"`
}

LoadBalancerHealthSummary A health status summary for the specified load balancer.

func (LoadBalancerHealthSummary) String Uses

func (m LoadBalancerHealthSummary) String() string

type LoadBalancerHealthSummaryStatusEnum Uses

type LoadBalancerHealthSummaryStatusEnum string

LoadBalancerHealthSummaryStatusEnum Enum with underlying type: string

const (
    LoadBalancerHealthSummaryStatusOk       LoadBalancerHealthSummaryStatusEnum = "OK"
    LoadBalancerHealthSummaryStatusWarning  LoadBalancerHealthSummaryStatusEnum = "WARNING"
    LoadBalancerHealthSummaryStatusCritical LoadBalancerHealthSummaryStatusEnum = "CRITICAL"
    LoadBalancerHealthSummaryStatusUnknown  LoadBalancerHealthSummaryStatusEnum = "UNKNOWN"
)

Set of constants representing the allowable values for LoadBalancerHealthSummaryStatusEnum

func GetLoadBalancerHealthSummaryStatusEnumValues Uses

func GetLoadBalancerHealthSummaryStatusEnumValues() []LoadBalancerHealthSummaryStatusEnum

GetLoadBalancerHealthSummaryStatusEnumValues Enumerates the set of values for LoadBalancerHealthSummaryStatusEnum

type LoadBalancerLifecycleStateEnum Uses

type LoadBalancerLifecycleStateEnum string

LoadBalancerLifecycleStateEnum Enum with underlying type: string

const (
    LoadBalancerLifecycleStateCreating LoadBalancerLifecycleStateEnum = "CREATING"
    LoadBalancerLifecycleStateFailed   LoadBalancerLifecycleStateEnum = "FAILED"
    LoadBalancerLifecycleStateActive   LoadBalancerLifecycleStateEnum = "ACTIVE"
    LoadBalancerLifecycleStateDeleting LoadBalancerLifecycleStateEnum = "DELETING"
    LoadBalancerLifecycleStateDeleted  LoadBalancerLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for LoadBalancerLifecycleStateEnum

func GetLoadBalancerLifecycleStateEnumValues Uses

func GetLoadBalancerLifecycleStateEnumValues() []LoadBalancerLifecycleStateEnum

GetLoadBalancerLifecycleStateEnumValues Enumerates the set of values for LoadBalancerLifecycleStateEnum

type LoadBalancerPolicy Uses

type LoadBalancerPolicy struct {

    // The name of a load balancing policy.
    // Example: 'LEAST_CONNECTIONS'
    Name *string `mandatory:"true" json:"name"`
}

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 (https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm).

func (LoadBalancerPolicy) String Uses

func (m LoadBalancerPolicy) String() string

type LoadBalancerProtocol Uses

type LoadBalancerProtocol struct {

    // The name of a protocol.
    // Example: 'HTTP'
    Name *string `mandatory:"true" json:"name"`
}

LoadBalancerProtocol A protocol that defines the type of traffic accepted by a listener.

func (LoadBalancerProtocol) String Uses

func (m LoadBalancerProtocol) String() string

type LoadBalancerShape Uses

type LoadBalancerShape struct {

    // The name of the shape.
    // Example: `100Mbps`
    Name *string `mandatory:"true" json:"name"`
}

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.

func (LoadBalancerShape) String Uses

func (m LoadBalancerShape) String() string

type PathMatchCondition Uses

type PathMatchCondition struct {

    // The path string that the redirection rule applies to.
    // Example: `/example`
    AttributeValue *string `mandatory:"true" json:"attributeValue"`

    // A string that specifies how to compare the PathMatchCondition object's `attributeValue` string to the
    // incoming URI.
    // *  **EXACT_MATCH** - The incoming URI path must exactly and completely match the `attributeValue` string.
    // *  **FORCE_LONGEST_PREFIX_MATCH** - The system looks for the `attributeValue` string with the best,
    //    longest match of the beginning portion of the incoming URI path.
    // *  **PREFIX_MATCH** - The beginning portion of the incoming URI path must exactly match the
    //    `attributeValue` string.
    // *  **SUFFIX_MATCH** - The ending portion of the incoming URI path must exactly match the `attributeValue`
    //    string.
    Operator PathMatchConditionOperatorEnum `mandatory:"true" json:"operator"`
}

PathMatchCondition The path string and match condition to apply when evaluating an incoming URI for redirection.

func (PathMatchCondition) MarshalJSON Uses

func (m PathMatchCondition) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PathMatchCondition) String Uses

func (m PathMatchCondition) String() string

type PathMatchConditionOperatorEnum Uses

type PathMatchConditionOperatorEnum string

PathMatchConditionOperatorEnum Enum with underlying type: string

const (
    PathMatchConditionOperatorExactMatch              PathMatchConditionOperatorEnum = "EXACT_MATCH"
    PathMatchConditionOperatorForceLongestPrefixMatch PathMatchConditionOperatorEnum = "FORCE_LONGEST_PREFIX_MATCH"
    PathMatchConditionOperatorPrefixMatch             PathMatchConditionOperatorEnum = "PREFIX_MATCH"
    PathMatchConditionOperatorSuffixMatch             PathMatchConditionOperatorEnum = "SUFFIX_MATCH"
)

Set of constants representing the allowable values for PathMatchConditionOperatorEnum

func GetPathMatchConditionOperatorEnumValues Uses

func GetPathMatchConditionOperatorEnumValues() []PathMatchConditionOperatorEnum

GetPathMatchConditionOperatorEnumValues Enumerates the set of values for PathMatchConditionOperatorEnum

type PathMatchType Uses

type PathMatchType struct {

    // Specifies how the load balancing service compares a PathRoute
    // object's `path` string against the incoming URI.
    // *  **EXACT_MATCH** - Looks for a `path` string that exactly matches the incoming URI path.
    // *  **FORCE_LONGEST_PREFIX_MATCH** - Looks for the `path` string with the best, longest match of the beginning
    //    portion of the incoming URI path.
    // *  **PREFIX_MATCH** - Looks for a `path` string that matches the beginning portion of the incoming URI path.
    // *  **SUFFIX_MATCH** - Looks for a `path` string that matches the ending portion of the incoming URI path.
    // For a full description of how the system handles `matchType` in a path route set containing multiple rules, see
    // Managing Request Routing (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm).
    MatchType PathMatchTypeMatchTypeEnum `mandatory:"true" json:"matchType"`
}

PathMatchType The type of matching to apply to incoming URIs.

func (PathMatchType) String Uses

func (m PathMatchType) String() string

type PathMatchTypeMatchTypeEnum Uses

type PathMatchTypeMatchTypeEnum string

PathMatchTypeMatchTypeEnum Enum with underlying type: string

const (
    PathMatchTypeMatchTypeExactMatch              PathMatchTypeMatchTypeEnum = "EXACT_MATCH"
    PathMatchTypeMatchTypeForceLongestPrefixMatch PathMatchTypeMatchTypeEnum = "FORCE_LONGEST_PREFIX_MATCH"
    PathMatchTypeMatchTypePrefixMatch             PathMatchTypeMatchTypeEnum = "PREFIX_MATCH"
    PathMatchTypeMatchTypeSuffixMatch             PathMatchTypeMatchTypeEnum = "SUFFIX_MATCH"
)

Set of constants representing the allowable values for PathMatchTypeMatchTypeEnum

func GetPathMatchTypeMatchTypeEnumValues Uses

func GetPathMatchTypeMatchTypeEnumValues() []PathMatchTypeMatchTypeEnum

GetPathMatchTypeMatchTypeEnumValues Enumerates the set of values for PathMatchTypeMatchTypeEnum

type PathRoute Uses

type PathRoute struct {

    // The path string to match against the incoming URI path.
    // *  Path strings are case-insensitive.
    // *  Asterisk (*) wildcards are not supported.
    // *  Regular expressions are not supported.
    // Example: `/example/video/123`
    Path *string `mandatory:"true" json:"path"`

    // The type of matching to apply to incoming URIs.
    PathMatchType *PathMatchType `mandatory:"true" json:"pathMatchType"`

    // The name of the target backend set for requests where the incoming URI matches the specified path.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" json:"backendSetName"`
}

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.

func (PathRoute) String Uses

func (m PathRoute) String() string

type PathRouteSet Uses

type PathRouteSet struct {

    // The unique name for this set of path route rules. Avoid entering confidential information.
    // Example: `example_path_route_set`
    Name *string `mandatory:"true" json:"name"`

    // The set of path route rules.
    PathRoutes []PathRoute `mandatory:"true" json:"pathRoutes"`
}

PathRouteSet A named set of path route rules. For more information, see Managing Request Routing (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (PathRouteSet) String Uses

func (m PathRouteSet) String() string

type PathRouteSetDetails Uses

type PathRouteSetDetails struct {

    // The set of path route rules.
    PathRoutes []PathRoute `mandatory:"true" json:"pathRoutes"`
}

PathRouteSetDetails A set of path route rules.

func (PathRouteSetDetails) String Uses

func (m PathRouteSetDetails) String() string

type RedirectRule Uses

type RedirectRule struct {
    Conditions []RuleCondition `mandatory:"true" json:"conditions"`

    // The HTTP status code to return when the incoming request is redirected.
    // The status line returned with the code is mapped from the standard HTTP specification. Valid response
    // codes for redirection are:
    // *  301
    // *  302
    // *  303
    // *  307
    // *  308
    // The default value is `302` (Found).
    // Example: `301`
    ResponseCode *int `mandatory:"false" json:"responseCode"`

    RedirectUri *RedirectUri `mandatory:"false" json:"redirectUri"`
}

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 RuleCondition

type `PATH`.

* A listener can have only one RedirectRule object for a given original path. The

PathMatchCondition `attributeValue` specifies the
original path.

func (RedirectRule) MarshalJSON Uses

func (m RedirectRule) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (RedirectRule) String Uses

func (m RedirectRule) String() string

func (*RedirectRule) UnmarshalJSON Uses

func (m *RedirectRule) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type RedirectUri Uses

type RedirectUri struct {

    // The HTTP protocol to use in the redirect URI.
    // When this value is null, not set, or set to `{protocol}`, the service preserves the original protocol from the
    // incoming HTTP request URI. Allowed values are:
    // *  HTTP
    // *  HTTPS
    // *  {protocol}
    // `{protocol}` is the only valid token for this property. It can appear only once in the value string.
    // Example: `HTTPS`
    Protocol *string `mandatory:"false" json:"protocol"`

    // The valid domain name (hostname) or IP address to use in the redirect URI.
    // When this value is null, not set, or set to `{host}`, the service preserves the original domain name from the
    // incoming HTTP request URI.
    // All RedirectUri tokens are valid for this property. You can use any token more than once.
    // Curly braces are valid in this property only to surround tokens, such as `{host}`
    // Examples:
    // *  **example.com** appears as `example.com` in the redirect URI.
    // *  **in{host}** appears as `inexample.com` in the redirect URI if `example.com` is the hostname in the
    //    incoming HTTP request URI.
    // *  **{port}{host}** appears as `8081example.com` in the redirect URI if `example.com` is the hostname and
    //    the port is `8081` in the incoming HTTP request URI.
    Host *string `mandatory:"false" json:"host"`

    // The communication port to use in the redirect URI.
    // Valid values include integers from 1 to 65535.
    // When this value is null, the service preserves the original port from the incoming HTTP request URI.
    // Example: `8081`
    Port *int `mandatory:"false" json:"port"`

    // The HTTP URI path to use in the redirect URI.
    // When this value is null, not set, or set to `{path}`, the service preserves the original path from the
    // incoming HTTP request URI. To omit the path from the redirect URI, set this value to an empty string, "".
    // All RedirectUri tokens are valid for this property. You can use any token more than once.
    // The path string must begin with `/` if it does not begin with the `{path}` token.
    // Examples:
    // *  __/example/video/123__ appears as `/example/video/123` in the redirect URI.
    // *  __/example{path}__ appears as `/example/video/123` in the redirect URI if `/video/123` is the path in the
    //    incoming HTTP request URI.
    // *  __{path}/123__ appears as `/example/video/123` in the redirect URI if `/example/video` is the path in the
    //    incoming HTTP request URI.
    // *  __{path}123__ appears as `/example/video123` in the redirect URI if `/example/video` is the path in the
    //    incoming HTTP request URI.
    // *  __/{host}/123__ appears as `/example.com/123` in the redirect URI if `example.com` is the hostname
    //    in the incoming HTTP request URI.
    // *  __/{host}/{port}__ appears as `/example.com/123` in the redirect URI if `example.com` is the hostname and
    //    `123` is the port in the incoming HTTP request URI.
    // *  __/{query}__ appears as `/lang=en` in the redirect URI if the query is `lang=en` in the incoming HTTP
    //    request URI.
    Path *string `mandatory:"false" json:"path"`

    // The query string to use in the redirect URI.
    // When this value is null, not set, or set to `{query}`, the service preserves the original query parameters
    // from the incoming HTTP request URI.
    // All `RedirectUri` tokens are valid for this property. You can use any token more than once.
    // If the query string does not begin with the `{query}` token, it must begin with the question mark (?) character.
    // You can specify multiple query parameters as a single string. Separate each query parameter with an ampersand
    // (&) character. To omit all incoming query parameters from the redirect URI, set this value to an empty
    // string, "".
    // If the specified query string results in a redirect URI ending with `?` or `&`, the last character is truncated.
    // For example, if the incoming URI is `http://host.com:8080/documents` and the query property value is
    // `?lang=en&{query}`, the redirect URI is `http://host.com:8080/documents?lang=en`. The system
    // truncates the final ampersand (&) because the incoming URI included no value to replace the {query} token.
    // Examples:
    // * **lang=en&time_zone=PST** appears as `lang=en&time_zone=PST` in the redirect URI.
    // * **{query}** appears as `lang=en&time_zone=PST` in the redirect URI if `lang=en&time_zone=PST` is the query
    //   string in the incoming HTTP request. If the incoming HTTP request has no query parameters, the `{query}`
    //   token renders as an empty string.
    // * **lang=en&{query}&time_zone=PST** appears as `lang=en&country=us&time_zone=PST` in the redirect URI if
    //   `country=us` is the query string in the incoming HTTP request. If the incoming HTTP request has no query
    //   parameters, this value renders as `lang=en&time_zone=PST`.
    // *  **protocol={protocol}&hostname={host}** appears as `protocol=http&hostname=example.com` in the redirect
    //    URI if the protocol is `HTTP` and the hostname is `example.com` in the incoming HTTP request.
    // *  **port={port}&hostname={host}** appears as `port=8080&hostname=example.com` in the redirect URI if the
    //    port is `8080` and the hostname is `example.com` in the incoming HTTP request URI.
    Query *string `mandatory:"false" json:"query"`
}

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}`

func (RedirectUri) String Uses

func (m RedirectUri) String() string

type RemoveHttpRequestHeaderRule Uses

type RemoveHttpRequestHeaderRule struct {

    // A header name that conforms to RFC 7230.
    // Example: `example_header_name`
    Header *string `mandatory:"true" json:"header"`
}

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.

func (RemoveHttpRequestHeaderRule) MarshalJSON Uses

func (m RemoveHttpRequestHeaderRule) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (RemoveHttpRequestHeaderRule) String Uses

func (m RemoveHttpRequestHeaderRule) String() string

type RemoveHttpResponseHeaderRule Uses

type RemoveHttpResponseHeaderRule struct {

    // A header name that conforms to RFC 7230.
    // Example: `example_header_name`
    Header *string `mandatory:"true" json:"header"`
}

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.

func (RemoveHttpResponseHeaderRule) MarshalJSON Uses

func (m RemoveHttpResponseHeaderRule) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (RemoveHttpResponseHeaderRule) String Uses

func (m RemoveHttpResponseHeaderRule) String() string

type Rule Uses

type Rule interface {
}

Rule An object that represents an action to apply to a listener.

type RuleActionEnum Uses

type RuleActionEnum string

RuleActionEnum Enum with underlying type: string

const (
    RuleActionAddHttpRequestHeader          RuleActionEnum = "ADD_HTTP_REQUEST_HEADER"
    RuleActionExtendHttpRequestHeaderValue  RuleActionEnum = "EXTEND_HTTP_REQUEST_HEADER_VALUE"
    RuleActionRemoveHttpRequestHeader       RuleActionEnum = "REMOVE_HTTP_REQUEST_HEADER"
    RuleActionAddHttpResponseHeader         RuleActionEnum = "ADD_HTTP_RESPONSE_HEADER"
    RuleActionExtendHttpResponseHeaderValue RuleActionEnum = "EXTEND_HTTP_RESPONSE_HEADER_VALUE"
    RuleActionRemoveHttpResponseHeader      RuleActionEnum = "REMOVE_HTTP_RESPONSE_HEADER"
    RuleActionAllow                         RuleActionEnum = "ALLOW"
    RuleActionControlAccessUsingHttpMethods RuleActionEnum = "CONTROL_ACCESS_USING_HTTP_METHODS"
    RuleActionRedirect                      RuleActionEnum = "REDIRECT"
)

Set of constants representing the allowable values for RuleActionEnum

func GetRuleActionEnumValues Uses

func GetRuleActionEnumValues() []RuleActionEnum

GetRuleActionEnumValues Enumerates the set of values for RuleActionEnum

type RuleCondition Uses

type RuleCondition interface {
}

RuleCondition A condition to apply to an access control rule.

type RuleConditionAttributeNameEnum Uses

type RuleConditionAttributeNameEnum string

RuleConditionAttributeNameEnum Enum with underlying type: string

const (
    RuleConditionAttributeNameSourceIpAddress    RuleConditionAttributeNameEnum = "SOURCE_IP_ADDRESS"
    RuleConditionAttributeNameSourceVcnId        RuleConditionAttributeNameEnum = "SOURCE_VCN_ID"
    RuleConditionAttributeNameSourceVcnIpAddress RuleConditionAttributeNameEnum = "SOURCE_VCN_IP_ADDRESS"
    RuleConditionAttributeNamePath               RuleConditionAttributeNameEnum = "PATH"
)

Set of constants representing the allowable values for RuleConditionAttributeNameEnum

func GetRuleConditionAttributeNameEnumValues Uses

func GetRuleConditionAttributeNameEnumValues() []RuleConditionAttributeNameEnum

GetRuleConditionAttributeNameEnumValues Enumerates the set of values for RuleConditionAttributeNameEnum

type RuleSet Uses

type RuleSet struct {

    // The name for this set of rules. It must be unique and it cannot be changed. Avoid entering
    // confidential information.
    // Example: `example_rule_set`
    Name *string `mandatory:"true" json:"name"`

    // An array of rules that compose the rule set.
    Items []Rule `mandatory:"true" json:"items"`
}

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 (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrulesets.htm).

func (RuleSet) String Uses

func (m RuleSet) String() string

func (*RuleSet) UnmarshalJSON Uses

func (m *RuleSet) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type RuleSetDetails Uses

type RuleSetDetails struct {

    // An array of rules that compose the rule set.
    Items []Rule `mandatory:"true" json:"items"`
}

RuleSetDetails The rules that compose a rule set.

func (RuleSetDetails) String Uses

func (m RuleSetDetails) String() string

func (*RuleSetDetails) UnmarshalJSON Uses

func (m *RuleSetDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type SessionPersistenceConfigurationDetails Uses

type SessionPersistenceConfigurationDetails struct {

    // The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify
    // that any cookie set by the backend causes the session to persist.
    // Example: `example_cookie`
    CookieName *string `mandatory:"true" json:"cookieName"`

    // Whether the load balancer is prevented from directing traffic from a persistent session client to
    // a different backend server if the original server is unavailable. Defaults to false.
    // Example: `false`
    DisableFallback *bool `mandatory:"false" json:"disableFallback"`
}

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 (https://docs.cloud.oracle.com/Content/Balance/Reference/sessionpersistence.htm). 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 UpdateBackendSet operation and specify `null` for the `SessionPersistenceConfigurationDetails` object. Example: `SessionPersistenceConfigurationDetails: null` **Note:** `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.

func (SessionPersistenceConfigurationDetails) String Uses

func (m SessionPersistenceConfigurationDetails) String() string

type SourceIpAddressCondition Uses

type SourceIpAddressCondition struct {

    // An IPv4 or IPv6 address range that the source IP address of an incoming packet must match.
    // The service accepts only classless inter-domain routing (CIDR) format (x.x.x.x/y or x:x::x/y) strings.
    // Specify 0.0.0.0/0 or ::/0 to match all incoming traffic.
    AttributeValue *string `mandatory:"true" json:"attributeValue"`
}

SourceIpAddressCondition An access control rule condition that requires a match on the specified source IP address or address range.

func (SourceIpAddressCondition) MarshalJSON Uses

func (m SourceIpAddressCondition) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (SourceIpAddressCondition) String Uses

func (m SourceIpAddressCondition) String() string

type SourceVcnIdCondition Uses

type SourceVcnIdCondition struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the originating VCN that an incoming packet
    // must match.
    // You can use this condition in conjunction with `SourceVcnIpAddressCondition`.
    // **NOTE:** If you define this condition for a rule without a `SourceVcnIpAddressCondition`, this condition
    // matches all incoming traffic in the specified VCN.
    AttributeValue *string `mandatory:"true" json:"attributeValue"`
}

SourceVcnIdCondition An access control rule condition that requires a match on the specified source VCN OCID.

func (SourceVcnIdCondition) MarshalJSON Uses

func (m SourceVcnIdCondition) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (SourceVcnIdCondition) String Uses

func (m SourceVcnIdCondition) String() string

type SourceVcnIpAddressCondition Uses

type SourceVcnIpAddressCondition struct {

    // An IPv4 address range that the original client IP address (in the context of the specified VCN) of an
    // incoming packet must match.
    // The service accepts only classless inter-domain routing (CIDR) format (x.x.x.x/y) strings.
    // Specify 0.0.0.0/0 to match all incoming traffic in the customer VCN.
    // example: "10.10.1.0/24"
    AttributeValue *string `mandatory:"true" json:"attributeValue"`
}

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`.

func (SourceVcnIpAddressCondition) MarshalJSON Uses

func (m SourceVcnIpAddressCondition) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (SourceVcnIpAddressCondition) String Uses

func (m SourceVcnIpAddressCondition) String() string

type SslConfiguration Uses

type SslConfiguration struct {

    // A friendly name for the certificate bundle. It must be unique and it cannot be changed.
    // Valid certificate bundle names include only alphanumeric characters, dashes, and underscores.
    // Certificate bundle names cannot contain spaces. Avoid entering confidential information.
    // Example: `example_certificate_bundle`
    CertificateName *string `mandatory:"true" json:"certificateName"`

    // Whether the load balancer listener should verify peer certificates.
    // Example: `true`
    VerifyPeerCertificate *bool `mandatory:"true" json:"verifyPeerCertificate"`

    // The maximum depth for peer certificate chain verification.
    // Example: `3`
    VerifyDepth *int `mandatory:"true" json:"verifyDepth"`
}

SslConfiguration A listener's SSL handling configuration. To use SSL, a listener must be associated with a Certificate. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (SslConfiguration) String Uses

func (m SslConfiguration) String() string

type SslConfigurationDetails Uses

type SslConfigurationDetails struct {

    // A friendly name for the certificate bundle. It must be unique and it cannot be changed.
    // Valid certificate bundle names include only alphanumeric characters, dashes, and underscores.
    // Certificate bundle names cannot contain spaces. Avoid entering confidential information.
    // Example: `example_certificate_bundle`
    CertificateName *string `mandatory:"true" json:"certificateName"`

    // Whether the load balancer listener should verify peer certificates.
    // Example: `true`
    VerifyPeerCertificate *bool `mandatory:"false" json:"verifyPeerCertificate"`

    // The maximum depth for peer certificate chain verification.
    // Example: `3`
    VerifyDepth *int `mandatory:"false" json:"verifyDepth"`
}

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.

func (SslConfigurationDetails) String Uses

func (m SslConfigurationDetails) String() string

type UpdateBackendDetails Uses

type UpdateBackendDetails struct {

    // The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger
    // proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections
    // as a server weighted '1'.
    // For more information on load balancing policies, see
    // How Load Balancing Policies Work (https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm).
    // Example: `3`
    Weight *int `mandatory:"true" json:"weight"`

    // Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress
    // traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.
    // **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy.
    // Example: `false`
    Backup *bool `mandatory:"true" json:"backup"`

    // Whether the load balancer should drain this server. Servers marked "drain" receive no new
    // incoming traffic.
    // Example: `false`
    Drain *bool `mandatory:"true" json:"drain"`

    // Whether the load balancer should treat this server as offline. Offline servers receive no incoming
    // traffic.
    // Example: `false`
    Offline *bool `mandatory:"true" json:"offline"`
}

UpdateBackendDetails The configuration details for updating a backend server.

func (UpdateBackendDetails) String Uses

func (m UpdateBackendDetails) String() string

type UpdateBackendRequest Uses

type UpdateBackendRequest struct {

    // Details for updating a backend server.
    UpdateBackendDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the backend set associated with the backend server.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`

    // The IP address and port of the backend server to update.
    // Example: `10.0.0.3:8080`
    BackendName *string `mandatory:"true" contributesTo:"path" name:"backendName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

UpdateBackendRequest wrapper for the UpdateBackend operation

func (UpdateBackendRequest) HTTPRequest Uses

func (request UpdateBackendRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBackendRequest) RetryPolicy Uses

func (request UpdateBackendRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBackendRequest) String Uses

func (request UpdateBackendRequest) String() string

type UpdateBackendResponse Uses

type UpdateBackendResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateBackendResponse wrapper for the UpdateBackend operation

func (UpdateBackendResponse) HTTPResponse Uses

func (response UpdateBackendResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBackendResponse) String Uses

func (response UpdateBackendResponse) String() string

type UpdateBackendSetDetails Uses

type UpdateBackendSetDetails struct {

    // The load balancer policy for the backend set. To get a list of available policies, use the
    // ListPolicies operation.
    // Example: `LEAST_CONNECTIONS`
    Policy *string `mandatory:"true" json:"policy"`

    Backends []BackendDetails `mandatory:"true" json:"backends"`

    HealthChecker *HealthCheckerDetails `mandatory:"true" json:"healthChecker"`

    SslConfiguration *SslConfigurationDetails `mandatory:"false" json:"sslConfiguration"`

    SessionPersistenceConfiguration *SessionPersistenceConfigurationDetails `mandatory:"false" json:"sessionPersistenceConfiguration"`

    LbCookieSessionPersistenceConfiguration *LbCookieSessionPersistenceConfigurationDetails `mandatory:"false" json:"lbCookieSessionPersistenceConfiguration"`
}

UpdateBackendSetDetails The configuration details for updating a load balancer backend set. For more information on backend set configuration, see Managing Backend Sets (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendsets.htm). **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.

func (UpdateBackendSetDetails) String Uses

func (m UpdateBackendSetDetails) String() string

type UpdateBackendSetRequest Uses

type UpdateBackendSetRequest struct {

    // The details to update a backend set.
    UpdateBackendSetDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the backend set to update.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

UpdateBackendSetRequest wrapper for the UpdateBackendSet operation

func (UpdateBackendSetRequest) HTTPRequest Uses

func (request UpdateBackendSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBackendSetRequest) RetryPolicy Uses

func (request UpdateBackendSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBackendSetRequest) String Uses

func (request UpdateBackendSetRequest) String() string

type UpdateBackendSetResponse Uses

type UpdateBackendSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateBackendSetResponse wrapper for the UpdateBackendSet operation

func (UpdateBackendSetResponse) HTTPResponse Uses

func (response UpdateBackendSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBackendSetResponse) String Uses

func (response UpdateBackendSetResponse) String() string

type UpdateHealthCheckerDetails Uses

type UpdateHealthCheckerDetails struct {

    // The protocol the health check must use; either HTTP or TCP.
    // Example: `HTTP`
    Protocol *string `mandatory:"true" json:"protocol"`

    // The backend server port against which to run the health check.
    // Example: `8080`
    Port *int `mandatory:"true" json:"port"`

    // The status code a healthy backend server should return.
    // Example: `200`
    ReturnCode *int `mandatory:"true" json:"returnCode"`

    // The number of retries to attempt before a backend server is considered "unhealthy". This number also applies
    // when recovering a server to the "healthy" state.
    // Example: `3`
    Retries *int `mandatory:"true" json:"retries"`

    // The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply
    // returns within this timeout period.
    // Example: `3000`
    TimeoutInMillis *int `mandatory:"true" json:"timeoutInMillis"`

    // The interval between health checks, in milliseconds.
    // Example: `10000`
    IntervalInMillis *int `mandatory:"true" json:"intervalInMillis"`

    // A regular expression for parsing the response body from the backend server.
    // Example: `^((?!false).|\s)*$`
    ResponseBodyRegex *string `mandatory:"true" json:"responseBodyRegex"`

    // The path against which to run the health check.
    // Example: `/healthcheck`
    UrlPath *string `mandatory:"false" json:"urlPath"`
}

UpdateHealthCheckerDetails The health checker's configuration details.

func (UpdateHealthCheckerDetails) String Uses

func (m UpdateHealthCheckerDetails) String() string

type UpdateHealthCheckerRequest Uses

type UpdateHealthCheckerRequest struct {

    // The health check policy configuration details.
    UpdateHealthCheckerDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the health check policy to be updated.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the backend set associated with the health check policy to be retrieved.
    // Example: `example_backend_set`
    BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

UpdateHealthCheckerRequest wrapper for the UpdateHealthChecker operation

func (UpdateHealthCheckerRequest) HTTPRequest Uses

func (request UpdateHealthCheckerRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateHealthCheckerRequest) RetryPolicy Uses

func (request UpdateHealthCheckerRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateHealthCheckerRequest) String Uses

func (request UpdateHealthCheckerRequest) String() string

type UpdateHealthCheckerResponse Uses

type UpdateHealthCheckerResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateHealthCheckerResponse wrapper for the UpdateHealthChecker operation

func (UpdateHealthCheckerResponse) HTTPResponse Uses

func (response UpdateHealthCheckerResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateHealthCheckerResponse) String Uses

func (response UpdateHealthCheckerResponse) String() string

type UpdateHostnameDetails Uses

type UpdateHostnameDetails struct {

    // The virtual hostname to update. For more information about virtual hostname string construction, see
    // Managing Request Routing (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm#routing).
    // Example: `app.example.com`
    Hostname *string `mandatory:"false" json:"hostname"`
}

UpdateHostnameDetails The configuration details for updating a virtual hostname. For more information on virtual hostnames, see Managing Request Routing (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm).

func (UpdateHostnameDetails) String Uses

func (m UpdateHostnameDetails) String() string

type UpdateHostnameRequest Uses

type UpdateHostnameRequest struct {

    // The configuration details to update a virtual hostname.
    UpdateHostnameDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the virtual hostname
    // to update.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the hostname resource to update.
    // Example: `example_hostname_001`
    Name *string `mandatory:"true" contributesTo:"path" name:"name"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

UpdateHostnameRequest wrapper for the UpdateHostname operation

func (UpdateHostnameRequest) HTTPRequest Uses

func (request UpdateHostnameRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateHostnameRequest) RetryPolicy Uses

func (request UpdateHostnameRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateHostnameRequest) String Uses

func (request UpdateHostnameRequest) String() string

type UpdateHostnameResponse Uses

type UpdateHostnameResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateHostnameResponse wrapper for the UpdateHostname operation

func (UpdateHostnameResponse) HTTPResponse Uses

func (response UpdateHostnameResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateHostnameResponse) String Uses

func (response UpdateHostnameResponse) String() string

type UpdateListenerDetails Uses

type UpdateListenerDetails struct {

    // The name of the associated backend set.
    // Example: `example_backend_set`
    DefaultBackendSetName *string `mandatory:"true" json:"defaultBackendSetName"`

    // The communication port for the listener.
    // Example: `80`
    Port *int `mandatory:"true" json:"port"`

    // The protocol on which the listener accepts connection requests.
    // To get a list of valid protocols, use the ListProtocols
    // operation.
    // Example: `HTTP`
    Protocol *string `mandatory:"true" json:"protocol"`

    // An array of hostname resource names.
    HostnameNames []string `mandatory:"false" json:"hostnameNames"`

    // The name of the set of path-based routing rules, PathRouteSet,
    // applied to this listener's traffic.
    // Example: `example_path_route_set`
    PathRouteSetName *string `mandatory:"false" json:"pathRouteSetName"`

    SslConfiguration *SslConfigurationDetails `mandatory:"false" json:"sslConfiguration"`

    ConnectionConfiguration *ConnectionConfiguration `mandatory:"false" json:"connectionConfiguration"`

    // The names of the RuleSet to apply to the listener.
    // Example: ["example_rule_set"]
    RuleSetNames []string `mandatory:"false" json:"ruleSetNames"`
}

UpdateListenerDetails The configuration details for updating a listener.

func (UpdateListenerDetails) String Uses

func (m UpdateListenerDetails) String() string

type UpdateListenerRequest Uses

type UpdateListenerRequest struct {

    // Details to update a listener.
    UpdateListenerDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener to update.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the listener to update.
    // Example: `example_listener`
    ListenerName *string `mandatory:"true" contributesTo:"path" name:"listenerName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

UpdateListenerRequest wrapper for the UpdateListener operation

func (UpdateListenerRequest) HTTPRequest Uses

func (request UpdateListenerRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateListenerRequest) RetryPolicy Uses

func (request UpdateListenerRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateListenerRequest) String Uses

func (request UpdateListenerRequest) String() string

type UpdateListenerResponse Uses

type UpdateListenerResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateListenerResponse wrapper for the UpdateListener operation

func (UpdateListenerResponse) HTTPResponse Uses

func (response UpdateListenerResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateListenerResponse) String Uses

func (response UpdateListenerResponse) String() string

type UpdateLoadBalancerDetails Uses

type UpdateLoadBalancerDetails struct {

    // The user-friendly display name for the load balancer. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    // Example: `example_load_balancer`
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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.

func (UpdateLoadBalancerDetails) String Uses

func (m UpdateLoadBalancerDetails) String() string

type UpdateLoadBalancerRequest Uses

type UpdateLoadBalancerRequest struct {

    // The details for updating a load balancer's configuration.
    UpdateLoadBalancerDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer to update.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

UpdateLoadBalancerRequest wrapper for the UpdateLoadBalancer operation

func (UpdateLoadBalancerRequest) HTTPRequest Uses

func (request UpdateLoadBalancerRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateLoadBalancerRequest) RetryPolicy Uses

func (request UpdateLoadBalancerRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateLoadBalancerRequest) String Uses

func (request UpdateLoadBalancerRequest) String() string

type UpdateLoadBalancerResponse Uses

type UpdateLoadBalancerResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateLoadBalancerResponse wrapper for the UpdateLoadBalancer operation

func (UpdateLoadBalancerResponse) HTTPResponse Uses

func (response UpdateLoadBalancerResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateLoadBalancerResponse) String Uses

func (response UpdateLoadBalancerResponse) String() string

type UpdateNetworkSecurityGroupsDetails Uses

type UpdateNetworkSecurityGroupsDetails struct {

    // An array of NSG OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with the load
    // balancer.
    // During the load balancer's creation, the service adds the new load balancer to the specified NSGs.
    // The benefits of associating the load balancer with NSGs include:
    // *  NSGs define network security rules to govern ingress and egress traffic for the load balancer.
    // *  The network security rules of other resources can reference the NSGs associated with the load balancer
    //    to ensure access.
    NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
}

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.

func (UpdateNetworkSecurityGroupsDetails) String Uses

func (m UpdateNetworkSecurityGroupsDetails) String() string

type UpdateNetworkSecurityGroupsRequest Uses

type UpdateNetworkSecurityGroupsRequest struct {

    // The details for updating the NSGs associated with the specified load balancer.
    UpdateNetworkSecurityGroupsDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer to update the NSGs for.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

UpdateNetworkSecurityGroupsRequest wrapper for the UpdateNetworkSecurityGroups operation

func (UpdateNetworkSecurityGroupsRequest) HTTPRequest Uses

func (request UpdateNetworkSecurityGroupsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateNetworkSecurityGroupsRequest) RetryPolicy Uses

func (request UpdateNetworkSecurityGroupsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateNetworkSecurityGroupsRequest) String Uses

func (request UpdateNetworkSecurityGroupsRequest) String() string

type UpdateNetworkSecurityGroupsResponse Uses

type UpdateNetworkSecurityGroupsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateNetworkSecurityGroupsResponse wrapper for the UpdateNetworkSecurityGroups operation

func (UpdateNetworkSecurityGroupsResponse) HTTPResponse Uses

func (response UpdateNetworkSecurityGroupsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateNetworkSecurityGroupsResponse) String Uses

func (response UpdateNetworkSecurityGroupsResponse) String() string

type UpdatePathRouteSetDetails Uses

type UpdatePathRouteSetDetails struct {

    // The set of path route rules.
    PathRoutes []PathRoute `mandatory:"true" json:"pathRoutes"`
}

UpdatePathRouteSetDetails An updated set of path route rules that overwrites the existing set of rules.

func (UpdatePathRouteSetDetails) String Uses

func (m UpdatePathRouteSetDetails) String() string

type UpdatePathRouteSetRequest Uses

type UpdatePathRouteSetRequest struct {

    // The configuration details to update a path route set.
    UpdatePathRouteSetDetails `contributesTo:"body"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route set to update.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the path route set to update.
    // Example: `example_path_route_set`
    PathRouteSetName *string `mandatory:"true" contributesTo:"path" name:"pathRouteSetName"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

UpdatePathRouteSetRequest wrapper for the UpdatePathRouteSet operation

func (UpdatePathRouteSetRequest) HTTPRequest Uses

func (request UpdatePathRouteSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdatePathRouteSetRequest) RetryPolicy Uses

func (request UpdatePathRouteSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdatePathRouteSetRequest) String Uses

func (request UpdatePathRouteSetRequest) String() string

type UpdatePathRouteSetResponse Uses

type UpdatePathRouteSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdatePathRouteSetResponse wrapper for the UpdatePathRouteSet operation

func (UpdatePathRouteSetResponse) HTTPResponse Uses

func (response UpdatePathRouteSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdatePathRouteSetResponse) String Uses

func (response UpdatePathRouteSetResponse) String() string

type UpdateRuleSetDetails Uses

type UpdateRuleSetDetails struct {

    // An array of rules that compose the rule set.
    Items []Rule `mandatory:"true" json:"items"`
}

UpdateRuleSetDetails An updated set of rules that overwrites the existing set of rules.

func (UpdateRuleSetDetails) String Uses

func (m UpdateRuleSetDetails) String() string

func (*UpdateRuleSetDetails) UnmarshalJSON Uses

func (m *UpdateRuleSetDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type UpdateRuleSetRequest Uses

type UpdateRuleSetRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the specified load balancer.
    LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`

    // The name of the rule set to update.
    // Example: `example_rule_set`
    RuleSetName *string `mandatory:"true" contributesTo:"path" name:"ruleSetName"`

    // The configuration details to update a set of rules.
    UpdateRuleSetDetails `contributesTo:"body"`

    // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

UpdateRuleSetRequest wrapper for the UpdateRuleSet operation

func (UpdateRuleSetRequest) HTTPRequest Uses

func (request UpdateRuleSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateRuleSetRequest) RetryPolicy Uses

func (request UpdateRuleSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateRuleSetRequest) String Uses

func (request UpdateRuleSetRequest) String() string

type UpdateRuleSetResponse Uses

type UpdateRuleSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateRuleSetResponse wrapper for the UpdateRuleSet operation

func (UpdateRuleSetResponse) HTTPResponse Uses

func (response UpdateRuleSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateRuleSetResponse) String Uses

func (response UpdateRuleSetResponse) String() string

type WorkRequest Uses

type WorkRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
    Id  *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer with which the work request
    // is associated.
    LoadBalancerId *string `mandatory:"true" json:"loadBalancerId"`

    // The type of action the work request represents.
    // Example: `CreateListener`
    Type *string `mandatory:"true" json:"type"`

    // The current state of the work request.
    LifecycleState WorkRequestLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // A collection of data, related to the load balancer provisioning process, that helps with debugging in the event of failure.
    // Possible data elements include:
    // - workflow name
    // - event ID
    // - work request ID
    // - load balancer ID
    // - workflow completion message
    Message *string `mandatory:"true" json:"message"`

    // The date and time the work request was created, in the format defined by RFC3339.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

    ErrorDetails []WorkRequestError `mandatory:"true" json:"errorDetails"`

    // The date and time the work request was completed, in the format defined by RFC3339.
    // Example: `2016-08-25T21:10:29.600Z`
    TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

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 (https://docs.cloud.oracle.com/Content/Balance/Tasks/viewingworkrequest.htm).

func (WorkRequest) String Uses

func (m WorkRequest) String() string

type WorkRequestError Uses

type WorkRequestError struct {
    ErrorCode WorkRequestErrorErrorCodeEnum `mandatory:"true" json:"errorCode"`

    // A human-readable error string.
    Message *string `mandatory:"true" json:"message"`
}

WorkRequestError An object returned in the event of a work request error.

func (WorkRequestError) String Uses

func (m WorkRequestError) String() string

type WorkRequestErrorErrorCodeEnum Uses

type WorkRequestErrorErrorCodeEnum string

WorkRequestErrorErrorCodeEnum Enum with underlying type: string

const (
    WorkRequestErrorErrorCodeBadInput      WorkRequestErrorErrorCodeEnum = "BAD_INPUT"
    WorkRequestErrorErrorCodeInternalError WorkRequestErrorErrorCodeEnum = "INTERNAL_ERROR"
)

Set of constants representing the allowable values for WorkRequestErrorErrorCodeEnum

func GetWorkRequestErrorErrorCodeEnumValues Uses

func GetWorkRequestErrorErrorCodeEnumValues() []WorkRequestErrorErrorCodeEnum

GetWorkRequestErrorErrorCodeEnumValues Enumerates the set of values for WorkRequestErrorErrorCodeEnum

type WorkRequestLifecycleStateEnum Uses

type WorkRequestLifecycleStateEnum string

WorkRequestLifecycleStateEnum Enum with underlying type: string

const (
    WorkRequestLifecycleStateAccepted   WorkRequestLifecycleStateEnum = "ACCEPTED"
    WorkRequestLifecycleStateInProgress WorkRequestLifecycleStateEnum = "IN_PROGRESS"
    WorkRequestLifecycleStateFailed     WorkRequestLifecycleStateEnum = "FAILED"
    WorkRequestLifecycleStateSucceeded  WorkRequestLifecycleStateEnum = "SUCCEEDED"
)

Set of constants representing the allowable values for WorkRequestLifecycleStateEnum

func GetWorkRequestLifecycleStateEnumValues Uses

func GetWorkRequestLifecycleStateEnumValues() []WorkRequestLifecycleStateEnum

GetWorkRequestLifecycleStateEnumValues Enumerates the set of values for WorkRequestLifecycleStateEnum

Package loadbalancer imports 5 packages (graph) and is imported by 2 packages. Updated 2020-04-06. Refresh now. Tools for package owners.