func GetActionNameEnumStringValues() []string
GetActionNameEnumStringValues Enumerates the set of values in String for ActionNameEnum
func GetBackendHealthStatusEnumStringValues() []string
GetBackendHealthStatusEnumStringValues Enumerates the set of values in String for BackendHealthStatusEnum
func GetBackendSetHealthStatusEnumStringValues() []string
GetBackendSetHealthStatusEnumStringValues Enumerates the set of values in String for BackendSetHealthStatusEnum
func GetCreateLoadBalancerDetailsIpModeEnumStringValues() []string
GetCreateLoadBalancerDetailsIpModeEnumStringValues Enumerates the set of values in String for CreateLoadBalancerDetailsIpModeEnum
func GetCreateRoutingPolicyDetailsConditionLanguageVersionEnumStringValues() []string
GetCreateRoutingPolicyDetailsConditionLanguageVersionEnumStringValues Enumerates the set of values in String for CreateRoutingPolicyDetailsConditionLanguageVersionEnum
func GetHealthCheckResultHealthCheckStatusEnumStringValues() []string
GetHealthCheckResultHealthCheckStatusEnumStringValues Enumerates the set of values in String for HealthCheckResultHealthCheckStatusEnum
func GetListLoadBalancersSortByEnumStringValues() []string
GetListLoadBalancersSortByEnumStringValues Enumerates the set of values in String for ListLoadBalancersSortByEnum
func GetListLoadBalancersSortOrderEnumStringValues() []string
GetListLoadBalancersSortOrderEnumStringValues Enumerates the set of values in String for ListLoadBalancersSortOrderEnum
func GetLoadBalancerHealthStatusEnumStringValues() []string
GetLoadBalancerHealthStatusEnumStringValues Enumerates the set of values in String for LoadBalancerHealthStatusEnum
func GetLoadBalancerHealthSummaryStatusEnumStringValues() []string
GetLoadBalancerHealthSummaryStatusEnumStringValues Enumerates the set of values in String for LoadBalancerHealthSummaryStatusEnum
func GetLoadBalancerLifecycleStateEnumStringValues() []string
GetLoadBalancerLifecycleStateEnumStringValues Enumerates the set of values in String for LoadBalancerLifecycleStateEnum
func GetPathMatchConditionOperatorEnumStringValues() []string
GetPathMatchConditionOperatorEnumStringValues Enumerates the set of values in String for PathMatchConditionOperatorEnum
func GetPathMatchTypeMatchTypeEnumStringValues() []string
GetPathMatchTypeMatchTypeEnumStringValues Enumerates the set of values in String for PathMatchTypeMatchTypeEnum
func GetRoutingPolicyConditionLanguageVersionEnumStringValues() []string
GetRoutingPolicyConditionLanguageVersionEnumStringValues Enumerates the set of values in String for RoutingPolicyConditionLanguageVersionEnum
func GetRuleActionEnumStringValues() []string
GetRuleActionEnumStringValues Enumerates the set of values in String for RuleActionEnum
func GetRuleConditionAttributeNameEnumStringValues() []string
GetRuleConditionAttributeNameEnumStringValues Enumerates the set of values in String for RuleConditionAttributeNameEnum
func GetSslConfigurationDetailsServerOrderPreferenceEnumStringValues() []string
GetSslConfigurationDetailsServerOrderPreferenceEnumStringValues Enumerates the set of values in String for SslConfigurationDetailsServerOrderPreferenceEnum
func GetSslConfigurationServerOrderPreferenceEnumStringValues() []string
GetSslConfigurationServerOrderPreferenceEnumStringValues Enumerates the set of values in String for SslConfigurationServerOrderPreferenceEnum
func GetUpdateRoutingPolicyDetailsConditionLanguageVersionEnumStringValues() []string
GetUpdateRoutingPolicyDetailsConditionLanguageVersionEnumStringValues Enumerates the set of values in String for UpdateRoutingPolicyDetailsConditionLanguageVersionEnum
func GetWorkRequestErrorErrorCodeEnumStringValues() []string
GetWorkRequestErrorErrorCodeEnumStringValues Enumerates the set of values in String for WorkRequestErrorErrorCodeEnum
func GetWorkRequestLifecycleStateEnumStringValues() []string
GetWorkRequestLifecycleStateEnumStringValues Enumerates the set of values in String for WorkRequestLifecycleStateEnum
Action An entity that represents an action to apply for a routing rule.
type Action interface {
}
ActionNameEnum Enum with underlying type: string
type ActionNameEnum string
Set of constants representing the allowable values for ActionNameEnum
const (
ActionNameForwardToBackendset ActionNameEnum = "FORWARD_TO_BACKENDSET"
)
func GetActionNameEnumValues() []ActionNameEnum
GetActionNameEnumValues Enumerates the set of values for ActionNameEnum
func GetMappingActionNameEnum(val string) (ActionNameEnum, bool)
GetMappingActionNameEnum performs case Insensitive comparison on enum value and return the desired enum
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.
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. With the following exceptions:
// * value cannot contain `$`
// * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid.
// Example: `example_value`
Value *string `mandatory:"true" json:"value"`
}
func (m AddHttpRequestHeaderRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AddHttpRequestHeaderRule) String() string
func (m AddHttpRequestHeaderRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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.
// With the following exceptions:
// * value cannot contain `$`
// * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid.
// Example: `example_value`
Value *string `mandatory:"true" json:"value"`
}
func (m AddHttpResponseHeaderRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AddHttpResponseHeaderRule) String() string
func (m AddHttpResponseHeaderRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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`
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"`
}
func (m AllowRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AllowRule) String() string
func (m *AllowRule) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AllowRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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).
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"`
}
func (m Backend) String() string
func (m Backend) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackendDetails The load balancing configuration details of a backend server.
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"`
}
func (m BackendDetails) String() string
func (m BackendDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackendHealth The health status of the specified backend server as reported by the primary and standby load balancers.
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"`
}
func (m BackendHealth) String() string
func (m BackendHealth) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackendHealthStatusEnum Enum with underlying type: string
type BackendHealthStatusEnum string
Set of constants representing the allowable values for BackendHealthStatusEnum
const (
BackendHealthStatusOk BackendHealthStatusEnum = "OK"
BackendHealthStatusWarning BackendHealthStatusEnum = "WARNING"
BackendHealthStatusCritical BackendHealthStatusEnum = "CRITICAL"
BackendHealthStatusUnknown BackendHealthStatusEnum = "UNKNOWN"
)
func GetBackendHealthStatusEnumValues() []BackendHealthStatusEnum
GetBackendHealthStatusEnumValues Enumerates the set of values for BackendHealthStatusEnum
func GetMappingBackendHealthStatusEnum(val string) (BackendHealthStatusEnum, bool)
GetMappingBackendHealthStatusEnum performs case Insensitive comparison on enum value and return the desired enum
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.
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"`
}
func (m BackendSet) String() string
func (m BackendSet) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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"`
}
func (m BackendSetDetails) String() string
func (m BackendSetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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"`
}
func (m BackendSetHealth) String() string
func (m BackendSetHealth) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackendSetHealthStatusEnum Enum with underlying type: string
type BackendSetHealthStatusEnum string
Set of constants representing the allowable values for BackendSetHealthStatusEnum
const (
BackendSetHealthStatusOk BackendSetHealthStatusEnum = "OK"
BackendSetHealthStatusWarning BackendSetHealthStatusEnum = "WARNING"
BackendSetHealthStatusCritical BackendSetHealthStatusEnum = "CRITICAL"
BackendSetHealthStatusUnknown BackendSetHealthStatusEnum = "UNKNOWN"
)
func GetBackendSetHealthStatusEnumValues() []BackendSetHealthStatusEnum
GetBackendSetHealthStatusEnumValues Enumerates the set of values for BackendSetHealthStatusEnum
func GetMappingBackendSetHealthStatusEnum(val string) (BackendSetHealthStatusEnum, bool)
GetMappingBackendSetHealthStatusEnum performs case Insensitive comparison on enum value and return the desired enum
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.
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"`
}
func (m Certificate) String() string
func (m Certificate) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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"`
}
func (m CertificateDetails) String() string
func (m CertificateDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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"`
}
func (m ChangeLoadBalancerCompartmentDetails) String() string
func (m ChangeLoadBalancerCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeLoadBalancerCompartmentRequest wrapper for the ChangeLoadBalancerCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ChangeLoadBalancerCompartment.go.html to see an example of how to use ChangeLoadBalancerCompartmentRequest.
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. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request ChangeLoadBalancerCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeLoadBalancerCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeLoadBalancerCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeLoadBalancerCompartmentRequest) String() string
func (request ChangeLoadBalancerCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeLoadBalancerCompartmentResponse wrapper for the ChangeLoadBalancerCompartment operation
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"`
}
func (response ChangeLoadBalancerCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeLoadBalancerCompartmentResponse) String() string
ConnectionConfiguration Configuration details for the connection between the client and backend servers.
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"`
}
func (m ConnectionConfiguration) String() string
func (m ConnectionConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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"`
}
func (m ControlAccessUsingHttpMethodsRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ControlAccessUsingHttpMethodsRule) String() string
func (m ControlAccessUsingHttpMethodsRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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).
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"`
}
func (m CreateBackendDetails) String() string
func (m CreateBackendDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateBackendRequest wrapper for the CreateBackend operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateBackend.go.html to see an example of how to use CreateBackendRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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"`
// 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
}
func (request CreateBackendRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBackendRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBackendRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBackendRequest) String() string
func (request CreateBackendRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateBackendResponse wrapper for the CreateBackend operation
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"`
}
func (response CreateBackendResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBackendResponse) String() string
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.
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"`
}
func (m CreateBackendSetDetails) String() string
func (m CreateBackendSetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateBackendSetRequest wrapper for the CreateBackendSet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateBackendSet.go.html to see an example of how to use CreateBackendSetRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request CreateBackendSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBackendSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBackendSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBackendSetRequest) String() string
func (request CreateBackendSetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateBackendSetResponse wrapper for the CreateBackendSet operation
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"`
}
func (response CreateBackendSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBackendSetResponse) String() string
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.
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"`
}
func (m CreateCertificateDetails) String() string
func (m CreateCertificateDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCertificateRequest wrapper for the CreateCertificate operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateCertificate.go.html to see an example of how to use CreateCertificateRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request CreateCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCertificateRequest) String() string
func (request CreateCertificateRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCertificateResponse wrapper for the CreateCertificate operation
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"`
}
func (response CreateCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCertificateResponse) String() string
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.
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"`
}
func (m CreateHostnameDetails) String() string
func (m CreateHostnameDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateHostnameRequest wrapper for the CreateHostname operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateHostname.go.html to see an example of how to use CreateHostnameRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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"`
// 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
}
func (request CreateHostnameRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateHostnameRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateHostnameRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateHostnameRequest) String() string
func (request CreateHostnameRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateHostnameResponse wrapper for the CreateHostname operation
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"`
}
func (response CreateHostnameResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateHostnameResponse) String() string
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.
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"`
// Deprecated. Please use `routingPolicies` instead.
// 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 name of the routing policy applied to this listener's traffic.
// Example: `example_routing_policy`
RoutingPolicyName *string `mandatory:"false" json:"routingPolicyName"`
// The names of the RuleSet to apply to the listener.
// Example: ["example_rule_set"]
RuleSetNames []string `mandatory:"false" json:"ruleSetNames"`
}
func (m CreateListenerDetails) String() string
func (m CreateListenerDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateListenerRequest wrapper for the CreateListener operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateListener.go.html to see an example of how to use CreateListenerRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request CreateListenerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateListenerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateListenerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateListenerRequest) String() string
func (request CreateListenerRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateListenerResponse wrapper for the CreateListener operation
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"`
}
func (response CreateListenerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateListenerResponse) String() string
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.
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: `flexible`
// NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape
// allowed would be `Flexible`
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"`
// The configuration details to create load balancer using Flexible shape. This is required only if shapeName is `Flexible`.
ShapeDetails *ShapeDetails `mandatory:"false" json:"shapeDetails"`
// 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"`
// An array of reserved Ips.
ReservedIps []ReservedIp `mandatory:"false" json:"reservedIps"`
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"`
SslCipherSuites map[string]SslCipherSuiteDetails `mandatory:"false" json:"sslCipherSuites"`
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"`
}
func (m CreateLoadBalancerDetails) String() string
func (m CreateLoadBalancerDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateLoadBalancerDetailsIpModeEnum Enum with underlying type: string
type CreateLoadBalancerDetailsIpModeEnum string
Set of constants representing the allowable values for CreateLoadBalancerDetailsIpModeEnum
const (
CreateLoadBalancerDetailsIpModeIpv4 CreateLoadBalancerDetailsIpModeEnum = "IPV4"
CreateLoadBalancerDetailsIpModeIpv6 CreateLoadBalancerDetailsIpModeEnum = "IPV6"
)
func GetCreateLoadBalancerDetailsIpModeEnumValues() []CreateLoadBalancerDetailsIpModeEnum
GetCreateLoadBalancerDetailsIpModeEnumValues Enumerates the set of values for CreateLoadBalancerDetailsIpModeEnum
func GetMappingCreateLoadBalancerDetailsIpModeEnum(val string) (CreateLoadBalancerDetailsIpModeEnum, bool)
GetMappingCreateLoadBalancerDetailsIpModeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateLoadBalancerRequest wrapper for the CreateLoadBalancer operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateLoadBalancer.go.html to see an example of how to use CreateLoadBalancerRequest.
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
}
func (request CreateLoadBalancerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateLoadBalancerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateLoadBalancerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateLoadBalancerRequest) String() string
func (request CreateLoadBalancerRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateLoadBalancerResponse wrapper for the CreateLoadBalancer operation
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"`
}
func (response CreateLoadBalancerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateLoadBalancerResponse) String() string
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.
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"`
}
func (m CreatePathRouteSetDetails) String() string
func (m CreatePathRouteSetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePathRouteSetRequest wrapper for the CreatePathRouteSet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreatePathRouteSet.go.html to see an example of how to use CreatePathRouteSetRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request CreatePathRouteSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePathRouteSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePathRouteSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePathRouteSetRequest) String() string
func (request CreatePathRouteSetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePathRouteSetResponse wrapper for the CreatePathRouteSet operation
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"`
}
func (response CreatePathRouteSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePathRouteSetResponse) String() string
CreateRoutingPolicyDetails An ordered list of routing rules. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CreateRoutingPolicyDetails struct {
// The name for this list of routing rules. It must be unique and it cannot be changed. Avoid entering
// confidential information.
// Example: `example_routing_rules`
Name *string `mandatory:"true" json:"name"`
// The version of the language in which `condition` of `rules` are composed.
ConditionLanguageVersion CreateRoutingPolicyDetailsConditionLanguageVersionEnum `mandatory:"true" json:"conditionLanguageVersion"`
// The list of routing rules.
Rules []RoutingRule `mandatory:"true" json:"rules"`
}
func (m CreateRoutingPolicyDetails) String() string
func (m CreateRoutingPolicyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateRoutingPolicyDetailsConditionLanguageVersionEnum Enum with underlying type: string
type CreateRoutingPolicyDetailsConditionLanguageVersionEnum string
Set of constants representing the allowable values for CreateRoutingPolicyDetailsConditionLanguageVersionEnum
const (
CreateRoutingPolicyDetailsConditionLanguageVersionV1 CreateRoutingPolicyDetailsConditionLanguageVersionEnum = "V1"
)
func GetCreateRoutingPolicyDetailsConditionLanguageVersionEnumValues() []CreateRoutingPolicyDetailsConditionLanguageVersionEnum
GetCreateRoutingPolicyDetailsConditionLanguageVersionEnumValues Enumerates the set of values for CreateRoutingPolicyDetailsConditionLanguageVersionEnum
func GetMappingCreateRoutingPolicyDetailsConditionLanguageVersionEnum(val string) (CreateRoutingPolicyDetailsConditionLanguageVersionEnum, bool)
GetMappingCreateRoutingPolicyDetailsConditionLanguageVersionEnum performs case Insensitive comparison on enum value and return the desired enum
CreateRoutingPolicyRequest wrapper for the CreateRoutingPolicy operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateRoutingPolicy.go.html to see an example of how to use CreateRoutingPolicyRequest.
type CreateRoutingPolicyRequest struct {
// The details of the routing policy rules to add.
CreateRoutingPolicyDetails `contributesTo:"body"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer to add the routing policy rule list 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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request CreateRoutingPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRoutingPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRoutingPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRoutingPolicyRequest) String() string
func (request CreateRoutingPolicyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateRoutingPolicyResponse wrapper for the CreateRoutingPolicy operation
type CreateRoutingPolicyResponse 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"`
}
func (response CreateRoutingPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRoutingPolicyResponse) String() string
CreateRuleSetDetails A named set of rules to add to the load balancer.
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"`
}
func (m CreateRuleSetDetails) String() string
func (m *CreateRuleSetDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateRuleSetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateRuleSetRequest wrapper for the CreateRuleSet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateRuleSet.go.html to see an example of how to use CreateRuleSetRequest.
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"`
// 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. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request CreateRuleSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRuleSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRuleSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRuleSetRequest) String() string
func (request CreateRuleSetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateRuleSetResponse wrapper for the CreateRuleSet operation
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"`
}
func (response CreateRuleSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRuleSetResponse) String() string
CreateSSLCipherSuiteRequest wrapper for the CreateSSLCipherSuite operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateSSLCipherSuite.go.html to see an example of how to use CreateSSLCipherSuiteRequest.
type CreateSSLCipherSuiteRequest struct {
// The details of the SSL cipher suite to add.
CreateSslCipherSuiteDetails `contributesTo:"body"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the associated load balancer.
LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`
// 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. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request CreateSSLCipherSuiteRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSSLCipherSuiteRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSSLCipherSuiteRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSSLCipherSuiteRequest) String() string
func (request CreateSSLCipherSuiteRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSSLCipherSuiteResponse wrapper for the CreateSSLCipherSuite operation
type CreateSSLCipherSuiteResponse 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"`
}
func (response CreateSSLCipherSuiteResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSSLCipherSuiteResponse) String() string
CreateSslCipherSuiteDetails The configuration details of an SSL cipher suite. The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer (SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to negotiate with peers while sending and receiving information. The cipher suites you use affect the security level, performance, and compatibility of your data traffic. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. Oracle created the following predefined cipher suites that you can specify when you define a resource's SSL configuration (https://docs.cloud.oracle.com/api/#/en/loadbalancer/20170115/datatypes/SSLConfigurationDetails). You can create custom cipher suites (https://docs.cloud.oracle.com/api/#/en/loadbalancer/20170115/SSLCipherSuite/CreateSSLCipherSuite) if the predefined cipher suites do not meet your requirements.
- __oci-default-ssl-cipher-suite-v1__ "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" - __oci-modern-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" - __oci-compatible-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" - __oci-wider-compatible-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "CAMELLIA128-SHA" "CAMELLIA256-SHA" "DES-CBC3-SHA" "DH-DSS-AES128-GCM-SHA256" "DH-DSS-AES128-SHA" "DH-DSS-AES128-SHA256" "DH-DSS-AES256-GCM-SHA384" "DH-DSS-AES256-SHA" "DH-DSS-AES256-SHA256" "DH-DSS-CAMELLIA128-SHA" "DH-DSS-CAMELLIA256-SHA" "DH-DSS-DES-CBC3-SHAv" "DH-DSS-SEED-SHA" "DH-RSA-AES128-GCM-SHA256" "DH-RSA-AES128-SHA" "DH-RSA-AES128-SHA256" "DH-RSA-AES256-GCM-SHA384" "DH-RSA-AES256-SHA" "DH-RSA-AES256-SHA256" "DH-RSA-CAMELLIA128-SHA" "DH-RSA-CAMELLIA256-SHA" "DH-RSA-DES-CBC3-SHA" "DH-RSA-SEED-SHA" "DHE-DSS-AES128-GCM-SHA256" "DHE-DSS-AES128-SHA" "DHE-DSS-AES128-SHA256" "DHE-DSS-AES256-GCM-SHA384" "DHE-DSS-AES256-SHA" "DHE-DSS-AES256-SHA256" "DHE-DSS-CAMELLIA128-SHA" "DHE-DSS-CAMELLIA256-SHA" "DHE-DSS-DES-CBC3-SHA" "DHE-DSS-SEED-SHA" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA" "DHE-RSA-AES256-SHA256" "DHE-RSA-CAMELLIA128-SHA" "DHE-RSA-CAMELLIA256-SHA" "DHE-RSA-DES-CBC3-SHA" "DHE-RSA-SEED-SHA" "ECDH-ECDSA-AES128-GCM-SHA256" "ECDH-ECDSA-AES128-SHA" "ECDH-ECDSA-AES128-SHA256" "ECDH-ECDSA-AES256-GCM-SHA384" "ECDH-ECDSA-AES256-SHA" "ECDH-ECDSA-AES256-SHA384" "ECDH-ECDSA-DES-CBC3-SHA" "ECDH-ECDSA-RC4-SHA" "ECDH-RSA-AES128-GCM-SHA256" "ECDH-RSA-AES128-SHA" "ECDH-RSA-AES128-SHA256" "ECDH-RSA-AES256-GCM-SHA384" "ECDH-RSA-AES256-SHA" "ECDH-RSA-AES256-SHA384" "ECDH-RSA-DES-CBC3-SHA" "ECDH-RSA-RC4-SHA" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-ECDSA-DES-CBC3-SHA" "ECDHE-ECDSA-RC4-SHA" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" "ECDHE-RSA-DES-CBC3-SHA" "ECDHE-RSA-RC4-SHA" "IDEA-CBC-SHA" "KRB5-DES-CBC3-MD5" "KRB5-DES-CBC3-SHA" "KRB5-IDEA-CBC-MD5" "KRB5-IDEA-CBC-SHA" "KRB5-RC4-MD5" "KRB5-RC4-SHA" "PSK-3DES-EDE-CBC-SHA" "PSK-AES128-CBC-SHA" "PSK-AES256-CBC-SHA" "PSK-RC4-SHA" "RC4-MD5" "RC4-SHA" "SEED-SHA" - __oci-default-http2-ssl-cipher-suite-v1__ "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES128-GCM-SHA256" - __oci-default-http2-tls-13-ssl-cipher-suite-v1__ "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" - __oci-default-http2-tls-12-13-ssl-cipher-suite-v1__ "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES128-GCM-SHA256" "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" - __oci-tls-13-recommended-ssl-cipher-suite-v1__ "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" - __oci-tls-12-13-wider-ssl-cipher-suite-v1__ "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES256-SHA384" "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" - __oci-tls-11-12-13-wider-ssl-cipher-suite-v1__ "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES256-SHA384" "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA" "AES128-SHA" "AES256-SHA"
type CreateSslCipherSuiteDetails struct {
// A friendly name for the SSL cipher suite. It must be unique and it cannot be changed.
// **Note:** The name of your user-defined cipher suite must not be the same as any of Oracle's predefined or
// reserved SSL cipher suite names:
// * oci-default-ssl-cipher-suite-v1
// * oci-modern-ssl-cipher-suite-v1
// * oci-compatible-ssl-cipher-suite-v1
// * oci-wider-compatible-ssl-cipher-suite-v1
// * oci-customized-ssl-cipher-suite
// * oci-default-http2-ssl-cipher-suite-v1
// * oci-default-http2-tls-13-ssl-cipher-suite-v1
// * oci-default-http2-tls-12-13-ssl-cipher-suite-v1
// * oci-tls-13-recommended-ssl-cipher-suite-v1
// * oci-tls-12-13-wider-ssl-cipher-suite-v1
// * oci-tls-11-12-13-wider-ssl-cipher-suite-v1
// example: `example_cipher_suite`
Name *string `mandatory:"true" json:"name"`
// A list of SSL ciphers the load balancer must support for HTTPS or SSL connections.
// The following ciphers are valid values for this property:
// * __TLSv1.3 ciphers__
// "TLS-AES-128-GCM-SHA256"
// "TLS-AES-256-GCM-SHA384"
// "TLS-CHACHA20-POLY1305-SHA256"
// "TLS-AES-128-CCM-SHA256"
// "TLS-AES-128-CCM-8-SHA256"
// * __TLSv1.2 ciphers__
// "AES128-GCM-SHA256"
// "AES128-SHA256"
// "AES256-GCM-SHA384"
// "AES256-SHA256"
// "DH-DSS-AES128-GCM-SHA256"
// "DH-DSS-AES128-SHA256"
// "DH-DSS-AES256-GCM-SHA384"
// "DH-DSS-AES256-SHA256"
// "DH-RSA-AES128-GCM-SHA256"
// "DH-RSA-AES128-SHA256"
// "DH-RSA-AES256-GCM-SHA384"
// "DH-RSA-AES256-SHA256"
// "DHE-DSS-AES128-GCM-SHA256"
// "DHE-DSS-AES128-SHA256"
// "DHE-DSS-AES256-GCM-SHA384"
// "DHE-DSS-AES256-SHA256"
// "DHE-RSA-AES128-GCM-SHA256"
// "DHE-RSA-AES128-SHA256"
// "DHE-RSA-AES256-GCM-SHA384"
// "DHE-RSA-AES256-SHA256"
// "ECDH-ECDSA-AES128-GCM-SHA256"
// "ECDH-ECDSA-AES128-SHA256"
// "ECDH-ECDSA-AES256-GCM-SHA384"
// "ECDH-ECDSA-AES256-SHA384"
// "ECDH-RSA-AES128-GCM-SHA256"
// "ECDH-RSA-AES128-SHA256"
// "ECDH-RSA-AES256-GCM-SHA384"
// "ECDH-RSA-AES256-SHA384"
// "ECDHE-ECDSA-AES128-GCM-SHA256"
// "ECDHE-ECDSA-AES128-SHA256"
// "ECDHE-ECDSA-AES256-GCM-SHA384"
// "ECDHE-ECDSA-AES256-SHA384"
// "ECDHE-RSA-AES128-GCM-SHA256"
// "ECDHE-RSA-AES128-SHA256"
// "ECDHE-RSA-AES256-GCM-SHA384"
// "ECDHE-RSA-AES256-SHA384"
// * __TLSv1 ciphers also supported by TLSv1.2__
// "AES128-SHA"
// "AES256-SHA"
// "CAMELLIA128-SHA"
// "CAMELLIA256-SHA"
// "DES-CBC3-SHA"
// "DH-DSS-AES128-SHA"
// "DH-DSS-AES256-SHA"
// "DH-DSS-CAMELLIA128-SHA"
// "DH-DSS-CAMELLIA256-SHA"
// "DH-DSS-DES-CBC3-SHAv"
// "DH-DSS-SEED-SHA"
// "DH-RSA-AES128-SHA"
// "DH-RSA-AES256-SHA"
// "DH-RSA-CAMELLIA128-SHA"
// "DH-RSA-CAMELLIA256-SHA"
// "DH-RSA-DES-CBC3-SHA"
// "DH-RSA-SEED-SHA"
// "DHE-DSS-AES128-SHA"
// "DHE-DSS-AES256-SHA"
// "DHE-DSS-CAMELLIA128-SHA"
// "DHE-DSS-CAMELLIA256-SHA"
// "DHE-DSS-DES-CBC3-SHA"
// "DHE-DSS-SEED-SHA"
// "DHE-RSA-AES128-SHA"
// "DHE-RSA-AES256-SHA"
// "DHE-RSA-CAMELLIA128-SHA"
// "DHE-RSA-CAMELLIA256-SHA"
// "DHE-RSA-DES-CBC3-SHA"
// "DHE-RSA-SEED-SHA"
// "ECDH-ECDSA-AES128-SHA"
// "ECDH-ECDSA-AES256-SHA"
// "ECDH-ECDSA-DES-CBC3-SHA"
// "ECDH-ECDSA-RC4-SHA"
// "ECDH-RSA-AES128-SHA"
// "ECDH-RSA-AES256-SHA"
// "ECDH-RSA-DES-CBC3-SHA"
// "ECDH-RSA-RC4-SHA"
// "ECDHE-ECDSA-AES128-SHA"
// "ECDHE-ECDSA-AES256-SHA"
// "ECDHE-ECDSA-DES-CBC3-SHA"
// "ECDHE-ECDSA-RC4-SHA"
// "ECDHE-RSA-AES128-SHA"
// "ECDHE-RSA-AES256-SHA"
// "ECDHE-RSA-DES-CBC3-SHA"
// "ECDHE-RSA-RC4-SHA"
// "IDEA-CBC-SHA"
// "KRB5-DES-CBC3-MD5"
// "KRB5-DES-CBC3-SHA"
// "KRB5-IDEA-CBC-MD5"
// "KRB5-IDEA-CBC-SHA"
// "KRB5-RC4-MD5"
// "KRB5-RC4-SHA"
// "PSK-3DES-EDE-CBC-SHA"
// "PSK-AES128-CBC-SHA"
// "PSK-AES256-CBC-SHA"
// "PSK-RC4-SHA"
// "RC4-MD5"
// "RC4-SHA"
// "SEED-SHA"
// example: `["ECDHE-RSA-AES256-GCM-SHA384","ECDHE-ECDSA-AES256-GCM-SHA384","ECDHE-RSA-AES128-GCM-SHA256"]`
Ciphers []string `mandatory:"true" json:"ciphers"`
}
func (m CreateSslCipherSuiteDetails) String() string
func (m CreateSslCipherSuiteDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteBackendRequest wrapper for the DeleteBackend operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteBackend.go.html to see an example of how to use DeleteBackendRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request DeleteBackendRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBackendRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBackendRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBackendRequest) String() string
func (request DeleteBackendRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteBackendResponse wrapper for the DeleteBackend operation
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"`
}
func (response DeleteBackendResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBackendResponse) String() string
DeleteBackendSetRequest wrapper for the DeleteBackendSet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteBackendSet.go.html to see an example of how to use DeleteBackendSetRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request DeleteBackendSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBackendSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBackendSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBackendSetRequest) String() string
func (request DeleteBackendSetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteBackendSetResponse wrapper for the DeleteBackendSet operation
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"`
}
func (response DeleteBackendSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBackendSetResponse) String() string
DeleteCertificateRequest wrapper for the DeleteCertificate operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteCertificate.go.html to see an example of how to use DeleteCertificateRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request DeleteCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteCertificateRequest) String() string
func (request DeleteCertificateRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteCertificateResponse wrapper for the DeleteCertificate operation
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"`
}
func (response DeleteCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteCertificateResponse) String() string
DeleteHostnameRequest wrapper for the DeleteHostname operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteHostname.go.html to see an example of how to use DeleteHostnameRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request DeleteHostnameRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteHostnameRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteHostnameRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteHostnameRequest) String() string
func (request DeleteHostnameRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteHostnameResponse wrapper for the DeleteHostname operation
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"`
}
func (response DeleteHostnameResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteHostnameResponse) String() string
DeleteListenerRequest wrapper for the DeleteListener operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteListener.go.html to see an example of how to use DeleteListenerRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request DeleteListenerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteListenerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteListenerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteListenerRequest) String() string
func (request DeleteListenerRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteListenerResponse wrapper for the DeleteListener operation
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"`
}
func (response DeleteListenerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteListenerResponse) String() string
DeleteLoadBalancerRequest wrapper for the DeleteLoadBalancer operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteLoadBalancer.go.html to see an example of how to use DeleteLoadBalancerRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request DeleteLoadBalancerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteLoadBalancerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteLoadBalancerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteLoadBalancerRequest) String() string
func (request DeleteLoadBalancerRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteLoadBalancerResponse wrapper for the DeleteLoadBalancer operation
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"`
}
func (response DeleteLoadBalancerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteLoadBalancerResponse) String() string
DeletePathRouteSetRequest wrapper for the DeletePathRouteSet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeletePathRouteSet.go.html to see an example of how to use DeletePathRouteSetRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request DeletePathRouteSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePathRouteSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePathRouteSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePathRouteSetRequest) String() string
func (request DeletePathRouteSetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeletePathRouteSetResponse wrapper for the DeletePathRouteSet operation
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"`
}
func (response DeletePathRouteSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePathRouteSetResponse) String() string
DeleteRoutingPolicyRequest wrapper for the DeleteRoutingPolicy operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteRoutingPolicy.go.html to see an example of how to use DeleteRoutingPolicyRequest.
type DeleteRoutingPolicyRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policy to delete.
LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`
// The name of the routing policy to delete.
// Example: `example_routing_policy`
RoutingPolicyName *string `mandatory:"true" contributesTo:"path" name:"routingPolicyName"`
// 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 optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request DeleteRoutingPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteRoutingPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRoutingPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRoutingPolicyRequest) String() string
func (request DeleteRoutingPolicyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteRoutingPolicyResponse wrapper for the DeleteRoutingPolicy operation
type DeleteRoutingPolicyResponse 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"`
}
func (response DeleteRoutingPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRoutingPolicyResponse) String() string
DeleteRuleSetRequest wrapper for the DeleteRuleSet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteRuleSet.go.html to see an example of how to use DeleteRuleSetRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request DeleteRuleSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteRuleSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRuleSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRuleSetRequest) String() string
func (request DeleteRuleSetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteRuleSetResponse wrapper for the DeleteRuleSet operation
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"`
}
func (response DeleteRuleSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRuleSetResponse) String() string
DeleteSSLCipherSuiteRequest wrapper for the DeleteSSLCipherSuite operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteSSLCipherSuite.go.html to see an example of how to use DeleteSSLCipherSuiteRequest.
type DeleteSSLCipherSuiteRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the associated load balancer.
LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`
// The name of the SSL cipher suite to delete.
// example: `example_cipher_suite`
Name *string `mandatory:"true" contributesTo:"path" name:"name"`
// 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 optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request DeleteSSLCipherSuiteRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSSLCipherSuiteRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSSLCipherSuiteRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSSLCipherSuiteRequest) String() string
func (request DeleteSSLCipherSuiteRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteSSLCipherSuiteResponse wrapper for the DeleteSSLCipherSuite operation
type DeleteSSLCipherSuiteResponse 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"`
}
func (response DeleteSSLCipherSuiteResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSSLCipherSuiteResponse) String() string
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.
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.
// With the following exceptions:
// * value cannot contain `$`
// * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid.
// 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.
// With the following exceptions:
// * value cannot contain `$`
// * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid.
// Example: `example_suffix_value`
Suffix *string `mandatory:"false" json:"suffix"`
}
func (m ExtendHttpRequestHeaderValueRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ExtendHttpRequestHeaderValueRule) String() string
func (m ExtendHttpRequestHeaderValueRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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.
// With the following exceptions:
// * value cannot contain `$`
// * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid.
// 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.
// With the following exceptions:
// * value cannot contain `$`
// * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid.
// Example: `example_suffix_value`
Suffix *string `mandatory:"false" json:"suffix"`
}
func (m ExtendHttpResponseHeaderValueRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ExtendHttpResponseHeaderValueRule) String() string
func (m ExtendHttpResponseHeaderValueRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ForwardToBackendSet Action to forward requests to a given backend set.
type ForwardToBackendSet struct {
// Name of the backend set the listener will forward the traffic to.
// Example: `backendSetForImages`
BackendSetName *string `mandatory:"true" json:"backendSetName"`
}
func (m ForwardToBackendSet) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ForwardToBackendSet) String() string
func (m ForwardToBackendSet) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetBackendHealthRequest wrapper for the GetBackendHealth operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetBackendHealth.go.html to see an example of how to use GetBackendHealthRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request GetBackendHealthRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBackendHealthRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBackendHealthRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBackendHealthRequest) String() string
func (request GetBackendHealthRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetBackendHealthResponse wrapper for the GetBackendHealth operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetBackendHealthResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBackendHealthResponse) String() string
GetBackendRequest wrapper for the GetBackend operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetBackend.go.html to see an example of how to use GetBackendRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request GetBackendRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBackendRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBackendRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBackendRequest) String() string
func (request GetBackendRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetBackendResponse wrapper for the GetBackend operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetBackendResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBackendResponse) String() string
GetBackendSetHealthRequest wrapper for the GetBackendSetHealth operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetBackendSetHealth.go.html to see an example of how to use GetBackendSetHealthRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request GetBackendSetHealthRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBackendSetHealthRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBackendSetHealthRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBackendSetHealthRequest) String() string
func (request GetBackendSetHealthRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetBackendSetHealthResponse wrapper for the GetBackendSetHealth operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetBackendSetHealthResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBackendSetHealthResponse) String() string
GetBackendSetRequest wrapper for the GetBackendSet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetBackendSet.go.html to see an example of how to use GetBackendSetRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request GetBackendSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBackendSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBackendSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBackendSetRequest) String() string
func (request GetBackendSetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetBackendSetResponse wrapper for the GetBackendSet operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetBackendSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBackendSetResponse) String() string
GetHealthCheckerRequest wrapper for the GetHealthChecker operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetHealthChecker.go.html to see an example of how to use GetHealthCheckerRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request GetHealthCheckerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetHealthCheckerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetHealthCheckerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetHealthCheckerRequest) String() string
func (request GetHealthCheckerRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetHealthCheckerResponse wrapper for the GetHealthChecker operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetHealthCheckerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetHealthCheckerResponse) String() string
GetHostnameRequest wrapper for the GetHostname operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetHostname.go.html to see an example of how to use GetHostnameRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request GetHostnameRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetHostnameRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetHostnameRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetHostnameRequest) String() string
func (request GetHostnameRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetHostnameResponse wrapper for the GetHostname operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetHostnameResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetHostnameResponse) String() string
GetLoadBalancerHealthRequest wrapper for the GetLoadBalancerHealth operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetLoadBalancerHealth.go.html to see an example of how to use GetLoadBalancerHealthRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request GetLoadBalancerHealthRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetLoadBalancerHealthRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetLoadBalancerHealthRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetLoadBalancerHealthRequest) String() string
func (request GetLoadBalancerHealthRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetLoadBalancerHealthResponse wrapper for the GetLoadBalancerHealth operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetLoadBalancerHealthResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetLoadBalancerHealthResponse) String() string
GetLoadBalancerRequest wrapper for the GetLoadBalancer operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetLoadBalancer.go.html to see an example of how to use GetLoadBalancerRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request GetLoadBalancerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetLoadBalancerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetLoadBalancerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetLoadBalancerRequest) String() string
func (request GetLoadBalancerRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetLoadBalancerResponse wrapper for the GetLoadBalancer operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetLoadBalancerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetLoadBalancerResponse) String() string
GetPathRouteSetRequest wrapper for the GetPathRouteSet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetPathRouteSet.go.html to see an example of how to use GetPathRouteSetRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request GetPathRouteSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPathRouteSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPathRouteSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPathRouteSetRequest) String() string
func (request GetPathRouteSetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetPathRouteSetResponse wrapper for the GetPathRouteSet operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetPathRouteSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPathRouteSetResponse) String() string
GetRoutingPolicyRequest wrapper for the GetRoutingPolicy operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetRoutingPolicy.go.html to see an example of how to use GetRoutingPolicyRequest.
type GetRoutingPolicyRequest 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 routing policy to retrieve.
// Example: `example_routing_policy`
RoutingPolicyName *string `mandatory:"true" contributesTo:"path" name:"routingPolicyName"`
// 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 optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request GetRoutingPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRoutingPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRoutingPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRoutingPolicyRequest) String() string
func (request GetRoutingPolicyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetRoutingPolicyResponse wrapper for the GetRoutingPolicy operation
type GetRoutingPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The RoutingPolicy instance
RoutingPolicy `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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetRoutingPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRoutingPolicyResponse) String() string
GetRuleSetRequest wrapper for the GetRuleSet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetRuleSet.go.html to see an example of how to use GetRuleSetRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request GetRuleSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRuleSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRuleSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRuleSetRequest) String() string
func (request GetRuleSetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetRuleSetResponse wrapper for the GetRuleSet operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetRuleSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRuleSetResponse) String() string
GetSSLCipherSuiteRequest wrapper for the GetSSLCipherSuite operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetSSLCipherSuite.go.html to see an example of how to use GetSSLCipherSuiteRequest.
type GetSSLCipherSuiteRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the associated load balancer.
LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`
// The name of the SSL cipher suite to retrieve.
// example: `example_cipher_suite`
Name *string `mandatory:"true" contributesTo:"path" name:"name"`
// 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 optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request GetSSLCipherSuiteRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSSLCipherSuiteRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSSLCipherSuiteRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSSLCipherSuiteRequest) String() string
func (request GetSSLCipherSuiteRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSSLCipherSuiteResponse wrapper for the GetSSLCipherSuite operation
type GetSSLCipherSuiteResponse struct {
// The underlying http response
RawResponse *http.Response
// The SslCipherSuite instance
SslCipherSuite `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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetSSLCipherSuiteResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSSLCipherSuiteResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
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
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
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"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HealthCheckResult Information about a single backend server health check result reported by a load balancer.
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"`
}
func (m HealthCheckResult) String() string
func (m HealthCheckResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HealthCheckResultHealthCheckStatusEnum Enum with underlying type: string
type HealthCheckResultHealthCheckStatusEnum string
Set of constants representing the allowable values for HealthCheckResultHealthCheckStatusEnum
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"
)
func GetHealthCheckResultHealthCheckStatusEnumValues() []HealthCheckResultHealthCheckStatusEnum
GetHealthCheckResultHealthCheckStatusEnumValues Enumerates the set of values for HealthCheckResultHealthCheckStatusEnum
func GetMappingHealthCheckResultHealthCheckStatusEnum(val string) (HealthCheckResultHealthCheckStatusEnum, bool)
GetMappingHealthCheckResultHealthCheckStatusEnum performs case Insensitive comparison on enum value and return the desired enum
HealthChecker The health check policy configuration. For more information, see Editing Health Check Policies (https://docs.cloud.oracle.com/Content/Balance/Tasks/editinghealthcheck.htm).
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"`
// Specifies if health checks should always be done using plain text instead of depending on
// whether or not the associated backend set is using SSL.
// If "true", health checks will be done using plain text even if the associated backend set is configured
// to use SSL.
// If "false", health checks will be done using SSL encryption if the associated backend set is configured
// to use SSL. If the backend set is not so configured the health checks will be done using plain text.
// Example: `false`
IsForcePlainText *bool `mandatory:"false" json:"isForcePlainText"`
}
func (m HealthChecker) String() string
func (m HealthChecker) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HealthCheckerDetails The health check policy's configuration details.
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"`
// Specifies if health checks should always be done using plain text instead of depending on
// whether or not the associated backend set is using SSL.
// If "true", health checks will be done using plain text even if the associated backend set is configured
// to use SSL.
// If "false", health checks will be done using SSL encryption if the associated backend set is configured
// to use SSL. If the backend set is not so configured the health checks will be done using plain text.
// Example: `false`
IsForcePlainText *bool `mandatory:"false" json:"isForcePlainText"`
}
func (m HealthCheckerDetails) String() string
func (m HealthCheckerDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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"`
}
func (m Hostname) String() string
func (m Hostname) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HostnameDetails The details of a hostname resource associated with a load balancer.
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"`
}
func (m HostnameDetails) String() string
func (m HostnameDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HttpHeaderRule An object that represents the advance http header options that allow the setting of http header size and allow/disallow invalid characters in the http headers. For example httpLargeHeaderSizeInKB=32, the http header could have 4 buffers of 32KBs each This rule applies only to HTTP listeners. No more than one `HttpHeaderRule` object can be present in a given listener.
type HttpHeaderRule struct {
// Indicates whether or not invalid characters in client header fields will be allowed.
// Valid names are composed of English letters, digits, hyphens and underscores.
// If "true", invalid characters are allowed in the HTTP header.
// If "false", invalid characters are not allowed in the HTTP header
AreInvalidCharactersAllowed *bool `mandatory:"false" json:"areInvalidCharactersAllowed"`
// The maximum size of each buffer used for reading http client request header.
// This value indicates the maximum size allowed for each buffer.
// The allowed values for buffer size are 8, 16, 32 and 64.
HttpLargeHeaderSizeInKB *int `mandatory:"false" json:"httpLargeHeaderSizeInKB"`
}
func (m HttpHeaderRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m HttpHeaderRule) String() string
func (m HttpHeaderRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IpAddress A load balancer IP address.
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"`
ReservedIp *ReservedIp `mandatory:"false" json:"reservedIp"`
}
func (m IpAddress) String() string
func (m IpAddress) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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"`
}
func (m LbCookieSessionPersistenceConfigurationDetails) String() string
func (m LbCookieSessionPersistenceConfigurationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListBackendSetsRequest wrapper for the ListBackendSets operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListBackendSets.go.html to see an example of how to use ListBackendSetsRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request ListBackendSetsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBackendSetsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBackendSetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBackendSetsRequest) String() string
func (request ListBackendSetsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListBackendSetsResponse wrapper for the ListBackendSets operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response ListBackendSetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBackendSetsResponse) String() string
ListBackendsRequest wrapper for the ListBackends operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListBackends.go.html to see an example of how to use ListBackendsRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request ListBackendsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBackendsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBackendsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBackendsRequest) String() string
func (request ListBackendsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListBackendsResponse wrapper for the ListBackends operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response ListBackendsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBackendsResponse) String() string
ListCertificatesRequest wrapper for the ListCertificates operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListCertificates.go.html to see an example of how to use ListCertificatesRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request ListCertificatesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCertificatesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCertificatesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCertificatesRequest) String() string
func (request ListCertificatesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListCertificatesResponse wrapper for the ListCertificates operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response ListCertificatesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCertificatesResponse) String() string
ListHostnamesRequest wrapper for the ListHostnames operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListHostnames.go.html to see an example of how to use ListHostnamesRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request ListHostnamesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListHostnamesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListHostnamesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListHostnamesRequest) String() string
func (request ListHostnamesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListHostnamesResponse wrapper for the ListHostnames operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response ListHostnamesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListHostnamesResponse) String() string
ListListenerRulesRequest wrapper for the ListListenerRules operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListListenerRules.go.html to see an example of how to use ListListenerRulesRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request ListListenerRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListListenerRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListListenerRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListListenerRulesRequest) String() string
func (request ListListenerRulesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListListenerRulesResponse wrapper for the ListListenerRules operation
type ListListenerRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// The []ListenerRuleSummary instance
Items []ListenerRuleSummary `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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response ListListenerRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListListenerRulesResponse) String() string
ListLoadBalancerHealthsRequest wrapper for the ListLoadBalancerHealths operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListLoadBalancerHealths.go.html to see an example of how to use ListLoadBalancerHealthsRequest.
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
}
func (request ListLoadBalancerHealthsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListLoadBalancerHealthsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListLoadBalancerHealthsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListLoadBalancerHealthsRequest) String() string
func (request ListLoadBalancerHealthsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListLoadBalancerHealthsResponse wrapper for the ListLoadBalancerHealths operation
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"`
}
func (response ListLoadBalancerHealthsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListLoadBalancerHealthsResponse) String() string
ListLoadBalancersRequest wrapper for the ListLoadBalancers operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListLoadBalancers.go.html to see an example of how to use ListLoadBalancersRequest.
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
}
func (request ListLoadBalancersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListLoadBalancersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListLoadBalancersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListLoadBalancersRequest) String() string
func (request ListLoadBalancersRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListLoadBalancersResponse wrapper for the ListLoadBalancers operation
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"`
}
func (response ListLoadBalancersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListLoadBalancersResponse) String() string
ListLoadBalancersSortByEnum Enum with underlying type: string
type ListLoadBalancersSortByEnum string
Set of constants representing the allowable values for ListLoadBalancersSortByEnum
const (
ListLoadBalancersSortByTimecreated ListLoadBalancersSortByEnum = "TIMECREATED"
ListLoadBalancersSortByDisplayname ListLoadBalancersSortByEnum = "DISPLAYNAME"
)
func GetListLoadBalancersSortByEnumValues() []ListLoadBalancersSortByEnum
GetListLoadBalancersSortByEnumValues Enumerates the set of values for ListLoadBalancersSortByEnum
func GetMappingListLoadBalancersSortByEnum(val string) (ListLoadBalancersSortByEnum, bool)
GetMappingListLoadBalancersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListLoadBalancersSortOrderEnum Enum with underlying type: string
type ListLoadBalancersSortOrderEnum string
Set of constants representing the allowable values for ListLoadBalancersSortOrderEnum
const (
ListLoadBalancersSortOrderAsc ListLoadBalancersSortOrderEnum = "ASC"
ListLoadBalancersSortOrderDesc ListLoadBalancersSortOrderEnum = "DESC"
)
func GetListLoadBalancersSortOrderEnumValues() []ListLoadBalancersSortOrderEnum
GetListLoadBalancersSortOrderEnumValues Enumerates the set of values for ListLoadBalancersSortOrderEnum
func GetMappingListLoadBalancersSortOrderEnum(val string) (ListLoadBalancersSortOrderEnum, bool)
GetMappingListLoadBalancersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPathRouteSetsRequest wrapper for the ListPathRouteSets operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListPathRouteSets.go.html to see an example of how to use ListPathRouteSetsRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request ListPathRouteSetsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPathRouteSetsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPathRouteSetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPathRouteSetsRequest) String() string
func (request ListPathRouteSetsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPathRouteSetsResponse wrapper for the ListPathRouteSets operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response ListPathRouteSetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPathRouteSetsResponse) String() string
ListPoliciesRequest wrapper for the ListPolicies operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListPolicies.go.html to see an example of how to use ListPoliciesRequest.
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
}
func (request ListPoliciesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPoliciesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPoliciesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPoliciesRequest) String() string
func (request ListPoliciesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPoliciesResponse wrapper for the ListPolicies operation
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"`
}
func (response ListPoliciesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPoliciesResponse) String() string
ListProtocolsRequest wrapper for the ListProtocols operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListProtocols.go.html to see an example of how to use ListProtocolsRequest.
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
}
func (request ListProtocolsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListProtocolsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListProtocolsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListProtocolsRequest) String() string
func (request ListProtocolsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListProtocolsResponse wrapper for the ListProtocols operation
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"`
}
func (response ListProtocolsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListProtocolsResponse) String() string
ListRoutingPoliciesRequest wrapper for the ListRoutingPolicies operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListRoutingPolicies.go.html to see an example of how to use ListRoutingPoliciesRequest.
type ListRoutingPoliciesRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policies.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request ListRoutingPoliciesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRoutingPoliciesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRoutingPoliciesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRoutingPoliciesRequest) String() string
func (request ListRoutingPoliciesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListRoutingPoliciesResponse wrapper for the ListRoutingPolicies operation
type ListRoutingPoliciesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []RoutingPolicy instances
Items []RoutingPolicy `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"`
// 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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response ListRoutingPoliciesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRoutingPoliciesResponse) String() string
ListRuleSetsRequest wrapper for the ListRuleSets operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListRuleSets.go.html to see an example of how to use ListRuleSetsRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request ListRuleSetsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRuleSetsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRuleSetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRuleSetsRequest) String() string
func (request ListRuleSetsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListRuleSetsResponse wrapper for the ListRuleSets operation
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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response ListRuleSetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRuleSetsResponse) String() string
ListSSLCipherSuitesRequest wrapper for the ListSSLCipherSuites operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListSSLCipherSuites.go.html to see an example of how to use ListSSLCipherSuitesRequest.
type ListSSLCipherSuitesRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the associated load balancer.
LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`
// 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 optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request ListSSLCipherSuitesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSSLCipherSuitesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSSLCipherSuitesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSSLCipherSuitesRequest) String() string
func (request ListSSLCipherSuitesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSSLCipherSuitesResponse wrapper for the ListSSLCipherSuites operation
type ListSSLCipherSuitesResponse struct {
// The underlying http response
RawResponse *http.Response
// The []SslCipherSuite instance
Items []SslCipherSuite `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"`
// Reflects the current version of the load balancer and the resources it contains.
// The value only changes when the load balancer or an associated resource is created,
// updated, or delete
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response ListSSLCipherSuitesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSSLCipherSuitesResponse) String() string
ListShapesRequest wrapper for the ListShapes operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListShapes.go.html to see an example of how to use ListShapesRequest.
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
}
func (request ListShapesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListShapesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListShapesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListShapesRequest) String() string
func (request ListShapesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListShapesResponse wrapper for the ListShapes operation
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"`
}
func (response ListShapesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListShapesResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
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
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
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"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
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).
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"`
// Deprecated. Please use `routingPolicies` instead.
// 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"`
// The name of the routing policy applied to this listener's traffic.
// Example: `example_routing_policy_name`
RoutingPolicyName *string `mandatory:"false" json:"routingPolicyName"`
}
func (m Listener) String() string
func (m Listener) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListenerDetails The listener's configuration details.
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"`
// Deprecated. Please use `routingPolicies` instead.
// 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 name of the routing policy applied to this listener's traffic.
// Example: `example_routing_policy`
RoutingPolicyName *string `mandatory:"false" json:"routingPolicyName"`
// The names of the RuleSet to apply to the listener.
// Example: ["example_rule_set"]
RuleSetNames []string `mandatory:"false" json:"ruleSetNames"`
}
func (m ListenerDetails) String() string
func (m ListenerDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListenerRuleSummary The attributes of a rule associated with the specified listener, and the name of the rule set that the rule belongs to.
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"`
}
func (m ListenerRuleSummary) String() string
func (m *ListenerRuleSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ListenerRuleSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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).
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"`
ShapeDetails *ShapeDetails `mandatory:"false" json:"shapeDetails"`
// 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"`
SslCipherSuites map[string]SslCipherSuite `mandatory:"false" json:"sslCipherSuites"`
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"`
RoutingPolicies map[string]RoutingPolicy `mandatory:"false" json:"routingPolicies"`
}
func (m LoadBalancer) String() string
func (m LoadBalancer) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
LoadBalancerClient a client for LoadBalancer
type LoadBalancerClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (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).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ChangeLoadBalancerCompartment.go.html to see an example of how to use ChangeLoadBalancerCompartment API.
func (client *LoadBalancerClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client LoadBalancerClient) CreateBackend(ctx context.Context, request CreateBackendRequest) (response CreateBackendResponse, err error)
CreateBackend Adds a backend server to a backend set.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateBackend.go.html to see an example of how to use CreateBackend API.
func (client LoadBalancerClient) CreateBackendSet(ctx context.Context, request CreateBackendSetRequest) (response CreateBackendSetResponse, err error)
CreateBackendSet Adds a backend set to a load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateBackendSet.go.html to see an example of how to use CreateBackendSet API.
func (client LoadBalancerClient) CreateCertificate(ctx context.Context, request CreateCertificateRequest) (response CreateCertificateResponse, err error)
CreateCertificate Creates an asynchronous request to add an SSL certificate bundle.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateCertificate.go.html to see an example of how to use CreateCertificate API.
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).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateHostname.go.html to see an example of how to use CreateHostname API.
func (client LoadBalancerClient) CreateListener(ctx context.Context, request CreateListenerRequest) (response CreateListenerResponse, err error)
CreateListener Adds a listener to a load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateListener.go.html to see an example of how to use CreateListener API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateLoadBalancer.go.html to see an example of how to use CreateLoadBalancer API.
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).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreatePathRouteSet.go.html to see an example of how to use CreatePathRouteSet API.
func (client LoadBalancerClient) CreateRoutingPolicy(ctx context.Context, request CreateRoutingPolicyRequest) (response CreateRoutingPolicyResponse, err error)
CreateRoutingPolicy Adds a routing policy to a load balancer. For more information, see Managing Request Routing (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateRoutingPolicy.go.html to see an example of how to use CreateRoutingPolicy API.
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).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateRuleSet.go.html to see an example of how to use CreateRuleSet API.
func (client LoadBalancerClient) CreateSSLCipherSuite(ctx context.Context, request CreateSSLCipherSuiteRequest) (response CreateSSLCipherSuiteResponse, err error)
CreateSSLCipherSuite Creates a custom SSL cipher suite.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/CreateSSLCipherSuite.go.html to see an example of how to use CreateSSLCipherSuite API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteBackend.go.html to see an example of how to use DeleteBackend API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteBackendSet.go.html to see an example of how to use DeleteBackendSet API.
func (client LoadBalancerClient) DeleteCertificate(ctx context.Context, request DeleteCertificateRequest) (response DeleteCertificateResponse, err error)
DeleteCertificate Deletes an SSL certificate bundle from a load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteCertificate.go.html to see an example of how to use DeleteCertificate API.
func (client LoadBalancerClient) DeleteHostname(ctx context.Context, request DeleteHostnameRequest) (response DeleteHostnameResponse, err error)
DeleteHostname Deletes a hostname resource from the specified load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteHostname.go.html to see an example of how to use DeleteHostname API.
func (client LoadBalancerClient) DeleteListener(ctx context.Context, request DeleteListenerRequest) (response DeleteListenerResponse, err error)
DeleteListener Deletes a listener from a load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteListener.go.html to see an example of how to use DeleteListener API.
func (client LoadBalancerClient) DeleteLoadBalancer(ctx context.Context, request DeleteLoadBalancerRequest) (response DeleteLoadBalancerResponse, err error)
DeleteLoadBalancer Stops a load balancer and removes it from service.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteLoadBalancer.go.html to see an example of how to use DeleteLoadBalancer API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeletePathRouteSet.go.html to see an example of how to use DeletePathRouteSet API.
func (client LoadBalancerClient) DeleteRoutingPolicy(ctx context.Context, request DeleteRoutingPolicyRequest) (response DeleteRoutingPolicyResponse, err error)
DeleteRoutingPolicy Deletes a routing policy from the specified load balancer. To delete a routing rule from a routing policy, use the UpdateRoutingPolicy operation.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteRoutingPolicy.go.html to see an example of how to use DeleteRoutingPolicy API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteRuleSet.go.html to see an example of how to use DeleteRuleSet API.
func (client LoadBalancerClient) DeleteSSLCipherSuite(ctx context.Context, request DeleteSSLCipherSuiteRequest) (response DeleteSSLCipherSuiteResponse, err error)
DeleteSSLCipherSuite Deletes an SSL cipher suite from a load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/DeleteSSLCipherSuite.go.html to see an example of how to use DeleteSSLCipherSuite API.
func (client LoadBalancerClient) GetBackend(ctx context.Context, request GetBackendRequest) (response GetBackendResponse, err error)
GetBackend Gets the specified backend server's configuration information.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetBackend.go.html to see an example of how to use GetBackend API.
func (client LoadBalancerClient) GetBackendHealth(ctx context.Context, request GetBackendHealthRequest) (response GetBackendHealthResponse, err error)
GetBackendHealth Gets the current health status of the specified backend server.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetBackendHealth.go.html to see an example of how to use GetBackendHealth API.
func (client LoadBalancerClient) GetBackendSet(ctx context.Context, request GetBackendSetRequest) (response GetBackendSetResponse, err error)
GetBackendSet Gets the specified backend set's configuration information.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetBackendSet.go.html to see an example of how to use GetBackendSet API.
func (client LoadBalancerClient) GetBackendSetHealth(ctx context.Context, request GetBackendSetHealthRequest) (response GetBackendSetHealthResponse, err error)
GetBackendSetHealth Gets the health status for the specified backend set.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetBackendSetHealth.go.html to see an example of how to use GetBackendSetHealth API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetHealthChecker.go.html to see an example of how to use GetHealthChecker API.
func (client LoadBalancerClient) GetHostname(ctx context.Context, request GetHostnameRequest) (response GetHostnameResponse, err error)
GetHostname Gets the specified hostname resource's configuration information.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetHostname.go.html to see an example of how to use GetHostname API.
func (client LoadBalancerClient) GetLoadBalancer(ctx context.Context, request GetLoadBalancerRequest) (response GetLoadBalancerResponse, err error)
GetLoadBalancer Gets the specified load balancer's configuration information.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetLoadBalancer.go.html to see an example of how to use GetLoadBalancer API.
func (client LoadBalancerClient) GetLoadBalancerHealth(ctx context.Context, request GetLoadBalancerHealthRequest) (response GetLoadBalancerHealthResponse, err error)
GetLoadBalancerHealth Gets the health status for the specified load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetLoadBalancerHealth.go.html to see an example of how to use GetLoadBalancerHealth API.
func (client LoadBalancerClient) GetPathRouteSet(ctx context.Context, request GetPathRouteSetRequest) (response GetPathRouteSetResponse, err error)
GetPathRouteSet Gets the specified path route set's configuration information.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetPathRouteSet.go.html to see an example of how to use GetPathRouteSet API.
func (client LoadBalancerClient) GetRoutingPolicy(ctx context.Context, request GetRoutingPolicyRequest) (response GetRoutingPolicyResponse, err error)
GetRoutingPolicy Gets the specified routing policy.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetRoutingPolicy.go.html to see an example of how to use GetRoutingPolicy API.
func (client LoadBalancerClient) GetRuleSet(ctx context.Context, request GetRuleSetRequest) (response GetRuleSetResponse, err error)
GetRuleSet Gets the specified set of rules.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetRuleSet.go.html to see an example of how to use GetRuleSet API.
func (client LoadBalancerClient) GetSSLCipherSuite(ctx context.Context, request GetSSLCipherSuiteRequest) (response GetSSLCipherSuiteResponse, err error)
GetSSLCipherSuite Gets the specified SSL cipher suite's configuration information.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetSSLCipherSuite.go.html to see an example of how to use GetSSLCipherSuite API.
func (client LoadBalancerClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the details of a work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.
func (client LoadBalancerClient) ListBackendSets(ctx context.Context, request ListBackendSetsRequest) (response ListBackendSetsResponse, err error)
ListBackendSets Lists all backend sets associated with a given load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListBackendSets.go.html to see an example of how to use ListBackendSets API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListBackends.go.html to see an example of how to use ListBackends API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListCertificates.go.html to see an example of how to use ListCertificates API.
func (client LoadBalancerClient) ListHostnames(ctx context.Context, request ListHostnamesRequest) (response ListHostnamesResponse, err error)
ListHostnames Lists all hostname resources associated with the specified load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListHostnames.go.html to see an example of how to use ListHostnames API.
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
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListListenerRules.go.html to see an example of how to use ListListenerRules API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListLoadBalancerHealths.go.html to see an example of how to use ListLoadBalancerHealths API.
func (client LoadBalancerClient) ListLoadBalancers(ctx context.Context, request ListLoadBalancersRequest) (response ListLoadBalancersResponse, err error)
ListLoadBalancers Lists all load balancers in the specified compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListLoadBalancers.go.html to see an example of how to use ListLoadBalancers API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListPathRouteSets.go.html to see an example of how to use ListPathRouteSets API.
func (client LoadBalancerClient) ListPolicies(ctx context.Context, request ListPoliciesRequest) (response ListPoliciesResponse, err error)
ListPolicies Lists the available load balancer policies.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListPolicies.go.html to see an example of how to use ListPolicies API.
func (client LoadBalancerClient) ListProtocols(ctx context.Context, request ListProtocolsRequest) (response ListProtocolsResponse, err error)
ListProtocols Lists all supported traffic protocols.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListProtocols.go.html to see an example of how to use ListProtocols API.
func (client LoadBalancerClient) ListRoutingPolicies(ctx context.Context, request ListRoutingPoliciesRequest) (response ListRoutingPoliciesResponse, err error)
ListRoutingPolicies Lists all routing policies associated with the specified load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListRoutingPolicies.go.html to see an example of how to use ListRoutingPolicies API.
func (client LoadBalancerClient) ListRuleSets(ctx context.Context, request ListRuleSetsRequest) (response ListRuleSetsResponse, err error)
ListRuleSets Lists all rule sets associated with the specified load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListRuleSets.go.html to see an example of how to use ListRuleSets API.
func (client LoadBalancerClient) ListSSLCipherSuites(ctx context.Context, request ListSSLCipherSuitesRequest) (response ListSSLCipherSuitesResponse, err error)
ListSSLCipherSuites Lists all SSL cipher suites associated with the specified load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListSSLCipherSuites.go.html to see an example of how to use ListSSLCipherSuites API.
func (client LoadBalancerClient) ListShapes(ctx context.Context, request ListShapesRequest) (response ListShapesResponse, err error)
ListShapes Lists the valid load balancer shapes.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListShapes.go.html to see an example of how to use ListShapes API.
func (client LoadBalancerClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests for a given load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.
func (client *LoadBalancerClient) SetRegion(region string)
SetRegion overrides the region of this client.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateBackend.go.html to see an example of how to use UpdateBackend API.
func (client LoadBalancerClient) UpdateBackendSet(ctx context.Context, request UpdateBackendSetRequest) (response UpdateBackendSetResponse, err error)
UpdateBackendSet Updates a backend set.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateBackendSet.go.html to see an example of how to use UpdateBackendSet API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateHealthChecker.go.html to see an example of how to use UpdateHealthChecker API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateHostname.go.html to see an example of how to use UpdateHostname API.
func (client LoadBalancerClient) UpdateListener(ctx context.Context, request UpdateListenerRequest) (response UpdateListenerResponse, err error)
UpdateListener Updates a listener for a given load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateListener.go.html to see an example of how to use UpdateListener API.
func (client LoadBalancerClient) UpdateLoadBalancer(ctx context.Context, request UpdateLoadBalancerRequest) (response UpdateLoadBalancerResponse, err error)
UpdateLoadBalancer Updates a load balancer's configuration.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateLoadBalancer.go.html to see an example of how to use UpdateLoadBalancer API.
func (client LoadBalancerClient) UpdateLoadBalancerShape(ctx context.Context, request UpdateLoadBalancerShapeRequest) (response UpdateLoadBalancerShapeResponse, err error)
UpdateLoadBalancerShape Update the shape of a load balancer. The new shape can be larger or smaller compared to existing shape of the LB. The service will try to perform this operation in the least disruptive way to existing connections, but there is a possibility that they might be lost during the LB resizing process. The new shape becomes effective as soon as the related work request completes successfully, i.e. when reshaping to a larger shape, the LB will start accepting larger bandwidth and when reshaping to a smaller one, the LB will be accepting smaller bandwidth.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateLoadBalancerShape.go.html to see an example of how to use UpdateLoadBalancerShape API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateNetworkSecurityGroups.go.html to see an example of how to use UpdateNetworkSecurityGroups API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdatePathRouteSet.go.html to see an example of how to use UpdatePathRouteSet API.
func (client LoadBalancerClient) UpdateRoutingPolicy(ctx context.Context, request UpdateRoutingPolicyRequest) (response UpdateRoutingPolicyResponse, err error)
UpdateRoutingPolicy Overwrites an existing routing policy on the specified load balancer. Use this operation to add, delete, or alter routing policy rules in a routing policy. To add a new routing rule to a routing policy, the body must include both the new routing rule to add and the existing rules to retain.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateRoutingPolicy.go.html to see an example of how to use UpdateRoutingPolicy API.
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateRuleSet.go.html to see an example of how to use UpdateRuleSet API.
func (client LoadBalancerClient) UpdateSSLCipherSuite(ctx context.Context, request UpdateSSLCipherSuiteRequest) (response UpdateSSLCipherSuiteResponse, err error)
UpdateSSLCipherSuite Updates an existing SSL cipher suite for the specified load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateSSLCipherSuite.go.html to see an example of how to use UpdateSSLCipherSuite API.
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.
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"`
}
func (m LoadBalancerHealth) String() string
func (m LoadBalancerHealth) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
LoadBalancerHealthStatusEnum Enum with underlying type: string
type LoadBalancerHealthStatusEnum string
Set of constants representing the allowable values for LoadBalancerHealthStatusEnum
const (
LoadBalancerHealthStatusOk LoadBalancerHealthStatusEnum = "OK"
LoadBalancerHealthStatusWarning LoadBalancerHealthStatusEnum = "WARNING"
LoadBalancerHealthStatusCritical LoadBalancerHealthStatusEnum = "CRITICAL"
LoadBalancerHealthStatusUnknown LoadBalancerHealthStatusEnum = "UNKNOWN"
)
func GetLoadBalancerHealthStatusEnumValues() []LoadBalancerHealthStatusEnum
GetLoadBalancerHealthStatusEnumValues Enumerates the set of values for LoadBalancerHealthStatusEnum
func GetMappingLoadBalancerHealthStatusEnum(val string) (LoadBalancerHealthStatusEnum, bool)
GetMappingLoadBalancerHealthStatusEnum performs case Insensitive comparison on enum value and return the desired enum
LoadBalancerHealthSummary A health status summary for the specified load balancer.
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"`
}
func (m LoadBalancerHealthSummary) String() string
func (m LoadBalancerHealthSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
LoadBalancerHealthSummaryStatusEnum Enum with underlying type: string
type LoadBalancerHealthSummaryStatusEnum string
Set of constants representing the allowable values for LoadBalancerHealthSummaryStatusEnum
const (
LoadBalancerHealthSummaryStatusOk LoadBalancerHealthSummaryStatusEnum = "OK"
LoadBalancerHealthSummaryStatusWarning LoadBalancerHealthSummaryStatusEnum = "WARNING"
LoadBalancerHealthSummaryStatusCritical LoadBalancerHealthSummaryStatusEnum = "CRITICAL"
LoadBalancerHealthSummaryStatusUnknown LoadBalancerHealthSummaryStatusEnum = "UNKNOWN"
)
func GetLoadBalancerHealthSummaryStatusEnumValues() []LoadBalancerHealthSummaryStatusEnum
GetLoadBalancerHealthSummaryStatusEnumValues Enumerates the set of values for LoadBalancerHealthSummaryStatusEnum
func GetMappingLoadBalancerHealthSummaryStatusEnum(val string) (LoadBalancerHealthSummaryStatusEnum, bool)
GetMappingLoadBalancerHealthSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
LoadBalancerLifecycleStateEnum Enum with underlying type: string
type LoadBalancerLifecycleStateEnum string
Set of constants representing the allowable values for LoadBalancerLifecycleStateEnum
const (
LoadBalancerLifecycleStateCreating LoadBalancerLifecycleStateEnum = "CREATING"
LoadBalancerLifecycleStateFailed LoadBalancerLifecycleStateEnum = "FAILED"
LoadBalancerLifecycleStateActive LoadBalancerLifecycleStateEnum = "ACTIVE"
LoadBalancerLifecycleStateDeleting LoadBalancerLifecycleStateEnum = "DELETING"
LoadBalancerLifecycleStateDeleted LoadBalancerLifecycleStateEnum = "DELETED"
)
func GetLoadBalancerLifecycleStateEnumValues() []LoadBalancerLifecycleStateEnum
GetLoadBalancerLifecycleStateEnumValues Enumerates the set of values for LoadBalancerLifecycleStateEnum
func GetMappingLoadBalancerLifecycleStateEnum(val string) (LoadBalancerLifecycleStateEnum, bool)
GetMappingLoadBalancerLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
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).
type LoadBalancerPolicy struct {
// The name of a load balancing policy.
// Example: 'LEAST_CONNECTIONS'
Name *string `mandatory:"true" json:"name"`
}
func (m LoadBalancerPolicy) String() string
func (m LoadBalancerPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
LoadBalancerProtocol A protocol that defines the type of traffic accepted by a listener.
type LoadBalancerProtocol struct {
// The name of a protocol.
// Example: 'HTTP'
Name *string `mandatory:"true" json:"name"`
}
func (m LoadBalancerProtocol) String() string
func (m LoadBalancerProtocol) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
type LoadBalancerShape struct {
// The name of the shape.
// Example: `100Mbps`
Name *string `mandatory:"true" json:"name"`
}
func (m LoadBalancerShape) String() string
func (m LoadBalancerShape) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PathMatchCondition The path string and match condition to apply when evaluating an incoming URI for redirection.
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"`
}
func (m PathMatchCondition) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PathMatchCondition) String() string
func (m PathMatchCondition) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PathMatchConditionOperatorEnum Enum with underlying type: string
type PathMatchConditionOperatorEnum string
Set of constants representing the allowable values for PathMatchConditionOperatorEnum
const (
PathMatchConditionOperatorExactMatch PathMatchConditionOperatorEnum = "EXACT_MATCH"
PathMatchConditionOperatorForceLongestPrefixMatch PathMatchConditionOperatorEnum = "FORCE_LONGEST_PREFIX_MATCH"
PathMatchConditionOperatorPrefixMatch PathMatchConditionOperatorEnum = "PREFIX_MATCH"
PathMatchConditionOperatorSuffixMatch PathMatchConditionOperatorEnum = "SUFFIX_MATCH"
)
func GetMappingPathMatchConditionOperatorEnum(val string) (PathMatchConditionOperatorEnum, bool)
GetMappingPathMatchConditionOperatorEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPathMatchConditionOperatorEnumValues() []PathMatchConditionOperatorEnum
GetPathMatchConditionOperatorEnumValues Enumerates the set of values for PathMatchConditionOperatorEnum
PathMatchType The type of matching to apply to incoming URIs.
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"`
}
func (m PathMatchType) String() string
func (m PathMatchType) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PathMatchTypeMatchTypeEnum Enum with underlying type: string
type PathMatchTypeMatchTypeEnum string
Set of constants representing the allowable values for PathMatchTypeMatchTypeEnum
const (
PathMatchTypeMatchTypeExactMatch PathMatchTypeMatchTypeEnum = "EXACT_MATCH"
PathMatchTypeMatchTypeForceLongestPrefixMatch PathMatchTypeMatchTypeEnum = "FORCE_LONGEST_PREFIX_MATCH"
PathMatchTypeMatchTypePrefixMatch PathMatchTypeMatchTypeEnum = "PREFIX_MATCH"
PathMatchTypeMatchTypeSuffixMatch PathMatchTypeMatchTypeEnum = "SUFFIX_MATCH"
)
func GetMappingPathMatchTypeMatchTypeEnum(val string) (PathMatchTypeMatchTypeEnum, bool)
GetMappingPathMatchTypeMatchTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPathMatchTypeMatchTypeEnumValues() []PathMatchTypeMatchTypeEnum
GetPathMatchTypeMatchTypeEnumValues Enumerates the set of values for PathMatchTypeMatchTypeEnum
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.
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"`
}
func (m PathRoute) String() string
func (m PathRoute) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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"`
}
func (m PathRouteSet) String() string
func (m PathRouteSet) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PathRouteSetDetails A set of path route rules.
type PathRouteSetDetails struct {
// The set of path route rules.
PathRoutes []PathRoute `mandatory:"true" json:"pathRoutes"`
}
func (m PathRouteSetDetails) String() string
func (m PathRouteSetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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"`
}
func (m RedirectRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RedirectRule) String() string
func (m *RedirectRule) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m RedirectRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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}`
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"`
}
func (m RedirectUri) String() string
func (m RedirectUri) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
type RemoveHttpRequestHeaderRule struct {
// A header name that conforms to RFC 7230.
// Example: `example_header_name`
Header *string `mandatory:"true" json:"header"`
}
func (m RemoveHttpRequestHeaderRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RemoveHttpRequestHeaderRule) String() string
func (m RemoveHttpRequestHeaderRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
type RemoveHttpResponseHeaderRule struct {
// A header name that conforms to RFC 7230.
// Example: `example_header_name`
Header *string `mandatory:"true" json:"header"`
}
func (m RemoveHttpResponseHeaderRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RemoveHttpResponseHeaderRule) String() string
func (m RemoveHttpResponseHeaderRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ReservedIp The representation of ReservedIp
type ReservedIp struct {
Id *string `mandatory:"false" json:"id"`
}
func (m ReservedIp) String() string
func (m ReservedIp) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RoutingPolicy A named ordered list of routing rules that is applied to a listener. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type RoutingPolicy struct {
// The unique name for this list of routing rules. Avoid entering confidential information.
// Example: `example_routing_policy`
Name *string `mandatory:"true" json:"name"`
// The version of the language in which `condition` of `rules` are composed.
ConditionLanguageVersion RoutingPolicyConditionLanguageVersionEnum `mandatory:"true" json:"conditionLanguageVersion"`
// The ordered list of routing rules.
Rules []RoutingRule `mandatory:"true" json:"rules"`
}
func (m RoutingPolicy) String() string
func (m RoutingPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RoutingPolicyConditionLanguageVersionEnum Enum with underlying type: string
type RoutingPolicyConditionLanguageVersionEnum string
Set of constants representing the allowable values for RoutingPolicyConditionLanguageVersionEnum
const (
RoutingPolicyConditionLanguageVersionV1 RoutingPolicyConditionLanguageVersionEnum = "V1"
)
func GetMappingRoutingPolicyConditionLanguageVersionEnum(val string) (RoutingPolicyConditionLanguageVersionEnum, bool)
GetMappingRoutingPolicyConditionLanguageVersionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRoutingPolicyConditionLanguageVersionEnumValues() []RoutingPolicyConditionLanguageVersionEnum
GetRoutingPolicyConditionLanguageVersionEnumValues Enumerates the set of values for RoutingPolicyConditionLanguageVersionEnum
RoutingPolicyDetails An ordered list of routing rules. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type RoutingPolicyDetails struct {
// The list of routing rules.
Rules []RoutingRule `mandatory:"true" json:"rules"`
}
func (m RoutingPolicyDetails) String() string
func (m RoutingPolicyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RoutingRule A routing rule examines an incoming request, routing matching requests to the specified backend set. Routing rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.
type RoutingRule struct {
// A unique name for the routing policy rule. Avoid entering confidential information.
Name *string `mandatory:"true" json:"name"`
// A routing rule to evaluate defined conditions against the incoming HTTP request and perform an action.
Condition *string `mandatory:"true" json:"condition"`
// A list of actions to be applied when conditions of the routing rule are met.
Actions []Action `mandatory:"true" json:"actions"`
}
func (m RoutingRule) String() string
func (m *RoutingRule) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m RoutingRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Rule An object that represents an action to apply to a listener.
type Rule interface {
}
RuleActionEnum Enum with underlying type: string
type RuleActionEnum string
Set of constants representing the allowable values for RuleActionEnum
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"
RuleActionHttpHeader RuleActionEnum = "HTTP_HEADER"
)
func GetMappingRuleActionEnum(val string) (RuleActionEnum, bool)
GetMappingRuleActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRuleActionEnumValues() []RuleActionEnum
GetRuleActionEnumValues Enumerates the set of values for RuleActionEnum
RuleCondition A condition to apply to an access control rule.
type RuleCondition interface {
}
RuleConditionAttributeNameEnum Enum with underlying type: string
type RuleConditionAttributeNameEnum string
Set of constants representing the allowable values for RuleConditionAttributeNameEnum
const (
RuleConditionAttributeNameSourceIpAddress RuleConditionAttributeNameEnum = "SOURCE_IP_ADDRESS"
RuleConditionAttributeNameSourceVcnId RuleConditionAttributeNameEnum = "SOURCE_VCN_ID"
RuleConditionAttributeNameSourceVcnIpAddress RuleConditionAttributeNameEnum = "SOURCE_VCN_IP_ADDRESS"
RuleConditionAttributeNamePath RuleConditionAttributeNameEnum = "PATH"
)
func GetMappingRuleConditionAttributeNameEnum(val string) (RuleConditionAttributeNameEnum, bool)
GetMappingRuleConditionAttributeNameEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRuleConditionAttributeNameEnumValues() []RuleConditionAttributeNameEnum
GetRuleConditionAttributeNameEnumValues Enumerates the set of values for RuleConditionAttributeNameEnum
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).
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"`
}
func (m RuleSet) String() string
func (m *RuleSet) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m RuleSet) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RuleSetDetails The rules that compose a rule set.
type RuleSetDetails struct {
// An array of rules that compose the rule set.
Items []Rule `mandatory:"true" json:"items"`
}
func (m RuleSetDetails) String() string
func (m *RuleSetDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m RuleSetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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"`
}
func (m SessionPersistenceConfigurationDetails) String() string
func (m SessionPersistenceConfigurationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ShapeDetails The configuration details to update load balancer to a different shape.
type ShapeDetails struct {
// Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress).
// The values must be between 10 and the maximumBandwidthInMbps.
// Example: `150`
MinimumBandwidthInMbps *int `mandatory:"true" json:"minimumBandwidthInMbps"`
// Bandwidth in Mbps that determines the maximum bandwidth (ingress plus egress) that the load balancer can
// achieve. This bandwidth cannot be always guaranteed. For a guaranteed bandwidth use the minimumBandwidthInMbps
// parameter.
// The values must be between minimumBandwidthInMbps and 8000 (8Gbps).
// Example: `1500`
MaximumBandwidthInMbps *int `mandatory:"true" json:"maximumBandwidthInMbps"`
}
func (m ShapeDetails) String() string
func (m ShapeDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SourceIpAddressCondition A rule condition that checks client source IP against specified IP address or address range.
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"`
}
func (m SourceIpAddressCondition) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SourceIpAddressCondition) String() string
func (m SourceIpAddressCondition) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SourceVcnIdCondition An access control rule condition that requires a match on the specified source VCN OCID.
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"`
}
func (m SourceVcnIdCondition) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SourceVcnIdCondition) String() string
func (m SourceVcnIdCondition) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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`.
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"`
}
func (m SourceVcnIpAddressCondition) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SourceVcnIpAddressCondition) String() string
func (m SourceVcnIpAddressCondition) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SslCipherSuite The configuration details of an SSL cipher suite. The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer (SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to negotiate with peers while sending and receiving information. The cipher suites you use affect the security level, performance, and compatibility of your data traffic. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. Oracle created the following predefined cipher suites that you can specify when you define a resource's SSL configuration (https://docs.cloud.oracle.com/api/#/en/loadbalancer/20170115/datatypes/SSLConfigurationDetails). You can create custom cipher suites (https://docs.cloud.oracle.com/api/#/en/loadbalancer/20170115/SSLCipherSuite/CreateSSLCipherSuite) if the predefined cipher suites do not meet your requirements.
- __oci-default-ssl-cipher-suite-v1__ "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" - __oci-modern-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" - __oci-compatible-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" - __oci-wider-compatible-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "CAMELLIA128-SHA" "CAMELLIA256-SHA" "DES-CBC3-SHA" "DH-DSS-AES128-GCM-SHA256" "DH-DSS-AES128-SHA" "DH-DSS-AES128-SHA256" "DH-DSS-AES256-GCM-SHA384" "DH-DSS-AES256-SHA" "DH-DSS-AES256-SHA256" "DH-DSS-CAMELLIA128-SHA" "DH-DSS-CAMELLIA256-SHA" "DH-DSS-DES-CBC3-SHAv" "DH-DSS-SEED-SHA" "DH-RSA-AES128-GCM-SHA256" "DH-RSA-AES128-SHA" "DH-RSA-AES128-SHA256" "DH-RSA-AES256-GCM-SHA384" "DH-RSA-AES256-SHA" "DH-RSA-AES256-SHA256" "DH-RSA-CAMELLIA128-SHA" "DH-RSA-CAMELLIA256-SHA" "DH-RSA-DES-CBC3-SHA" "DH-RSA-SEED-SHA" "DHE-DSS-AES128-GCM-SHA256" "DHE-DSS-AES128-SHA" "DHE-DSS-AES128-SHA256" "DHE-DSS-AES256-GCM-SHA384" "DHE-DSS-AES256-SHA" "DHE-DSS-AES256-SHA256" "DHE-DSS-CAMELLIA128-SHA" "DHE-DSS-CAMELLIA256-SHA" "DHE-DSS-DES-CBC3-SHA" "DHE-DSS-SEED-SHA" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA" "DHE-RSA-AES256-SHA256" "DHE-RSA-CAMELLIA128-SHA" "DHE-RSA-CAMELLIA256-SHA" "DHE-RSA-DES-CBC3-SHA" "DHE-RSA-SEED-SHA" "ECDH-ECDSA-AES128-GCM-SHA256" "ECDH-ECDSA-AES128-SHA" "ECDH-ECDSA-AES128-SHA256" "ECDH-ECDSA-AES256-GCM-SHA384" "ECDH-ECDSA-AES256-SHA" "ECDH-ECDSA-AES256-SHA384" "ECDH-ECDSA-DES-CBC3-SHA" "ECDH-ECDSA-RC4-SHA" "ECDH-RSA-AES128-GCM-SHA256" "ECDH-RSA-AES128-SHA" "ECDH-RSA-AES128-SHA256" "ECDH-RSA-AES256-GCM-SHA384" "ECDH-RSA-AES256-SHA" "ECDH-RSA-AES256-SHA384" "ECDH-RSA-DES-CBC3-SHA" "ECDH-RSA-RC4-SHA" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-ECDSA-DES-CBC3-SHA" "ECDHE-ECDSA-RC4-SHA" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" "ECDHE-RSA-DES-CBC3-SHA" "ECDHE-RSA-RC4-SHA" "IDEA-CBC-SHA" "KRB5-DES-CBC3-MD5" "KRB5-DES-CBC3-SHA" "KRB5-IDEA-CBC-MD5" "KRB5-IDEA-CBC-SHA" "KRB5-RC4-MD5" "KRB5-RC4-SHA" "PSK-3DES-EDE-CBC-SHA" "PSK-AES128-CBC-SHA" "PSK-AES256-CBC-SHA" "PSK-RC4-SHA" "RC4-MD5" "RC4-SHA" "SEED-SHA" - __oci-default-http2-ssl-cipher-suite-v1__ "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES128-GCM-SHA256" - __oci-default-http2-tls-13-ssl-cipher-suite-v1__ "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" - __oci-default-http2-tls-12-13-ssl-cipher-suite-v1__ "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES128-GCM-SHA256" "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" - __oci-tls-13-recommended-ssl-cipher-suite-v1__ "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" - __oci-tls-12-13-wider-ssl-cipher-suite-v1__ "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES256-SHA384" "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" - __oci-tls-11-12-13-wider-ssl-cipher-suite-v1__ "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES256-SHA384" "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA" "AES128-SHA" "AES256-SHA"
type SslCipherSuite struct {
// A friendly name for the SSL cipher suite. It must be unique and it cannot be changed.
// **Note:** The name of your user-defined cipher suite must not be the same as any of Oracle's predefined or
// reserved SSL cipher suite names:
// * oci-default-ssl-cipher-suite-v1
// * oci-modern-ssl-cipher-suite-v1
// * oci-compatible-ssl-cipher-suite-v1
// * oci-wider-compatible-ssl-cipher-suite-v1
// * oci-customized-ssl-cipher-suite
// * oci-default-http2-ssl-cipher-suite-v1
// * oci-default-http2-tls-13-ssl-cipher-suite-v1
// * oci-default-http2-tls-12-13-ssl-cipher-suite-v1
// * oci-tls-13-recommended-ssl-cipher-suite-v1
// * oci-tls-12-13-wider-ssl-cipher-suite-v1
// * oci-tls-11-12-13-wider-ssl-cipher-suite-v1
// example: `example_cipher_suite`
Name *string `mandatory:"true" json:"name"`
// A list of SSL ciphers the load balancer must support for HTTPS or SSL connections.
// The following ciphers are valid values for this property:
// * __TLSv1.3 ciphers__
// "TLS-AES-128-GCM-SHA256"
// "TLS-AES-256-GCM-SHA384"
// "TLS-CHACHA20-POLY1305-SHA256"
// "TLS-AES-128-CCM-SHA256"
// "TLS-AES-128-CCM-8-SHA256"
// * __TLSv1.2 ciphers__
// "AES128-GCM-SHA256"
// "AES128-SHA256"
// "AES256-GCM-SHA384"
// "AES256-SHA256"
// "DH-DSS-AES128-GCM-SHA256"
// "DH-DSS-AES128-SHA256"
// "DH-DSS-AES256-GCM-SHA384"
// "DH-DSS-AES256-SHA256"
// "DH-RSA-AES128-GCM-SHA256"
// "DH-RSA-AES128-SHA256"
// "DH-RSA-AES256-GCM-SHA384"
// "DH-RSA-AES256-SHA256"
// "DHE-DSS-AES128-GCM-SHA256"
// "DHE-DSS-AES128-SHA256"
// "DHE-DSS-AES256-GCM-SHA384"
// "DHE-DSS-AES256-SHA256"
// "DHE-RSA-AES128-GCM-SHA256"
// "DHE-RSA-AES128-SHA256"
// "DHE-RSA-AES256-GCM-SHA384"
// "DHE-RSA-AES256-SHA256"
// "ECDH-ECDSA-AES128-GCM-SHA256"
// "ECDH-ECDSA-AES128-SHA256"
// "ECDH-ECDSA-AES256-GCM-SHA384"
// "ECDH-ECDSA-AES256-SHA384"
// "ECDH-RSA-AES128-GCM-SHA256"
// "ECDH-RSA-AES128-SHA256"
// "ECDH-RSA-AES256-GCM-SHA384"
// "ECDH-RSA-AES256-SHA384"
// "ECDHE-ECDSA-AES128-GCM-SHA256"
// "ECDHE-ECDSA-AES128-SHA256"
// "ECDHE-ECDSA-AES256-GCM-SHA384"
// "ECDHE-ECDSA-AES256-SHA384"
// "ECDHE-RSA-AES128-GCM-SHA256"
// "ECDHE-RSA-AES128-SHA256"
// "ECDHE-RSA-AES256-GCM-SHA384"
// "ECDHE-RSA-AES256-SHA384"
// * __TLSv1 ciphers also supported by TLSv1.2__
// "AES128-SHA"
// "AES256-SHA"
// "CAMELLIA128-SHA"
// "CAMELLIA256-SHA"
// "DES-CBC3-SHA"
// "DH-DSS-AES128-SHA"
// "DH-DSS-AES256-SHA"
// "DH-DSS-CAMELLIA128-SHA"
// "DH-DSS-CAMELLIA256-SHA"
// "DH-DSS-DES-CBC3-SHAv"
// "DH-DSS-SEED-SHA"
// "DH-RSA-AES128-SHA"
// "DH-RSA-AES256-SHA"
// "DH-RSA-CAMELLIA128-SHA"
// "DH-RSA-CAMELLIA256-SHA"
// "DH-RSA-DES-CBC3-SHA"
// "DH-RSA-SEED-SHA"
// "DHE-DSS-AES128-SHA"
// "DHE-DSS-AES256-SHA"
// "DHE-DSS-CAMELLIA128-SHA"
// "DHE-DSS-CAMELLIA256-SHA"
// "DHE-DSS-DES-CBC3-SHA"
// "DHE-DSS-SEED-SHA"
// "DHE-RSA-AES128-SHA"
// "DHE-RSA-AES256-SHA"
// "DHE-RSA-CAMELLIA128-SHA"
// "DHE-RSA-CAMELLIA256-SHA"
// "DHE-RSA-DES-CBC3-SHA"
// "DHE-RSA-SEED-SHA"
// "ECDH-ECDSA-AES128-SHA"
// "ECDH-ECDSA-AES256-SHA"
// "ECDH-ECDSA-DES-CBC3-SHA"
// "ECDH-ECDSA-RC4-SHA"
// "ECDH-RSA-AES128-SHA"
// "ECDH-RSA-AES256-SHA"
// "ECDH-RSA-DES-CBC3-SHA"
// "ECDH-RSA-RC4-SHA"
// "ECDHE-ECDSA-AES128-SHA"
// "ECDHE-ECDSA-AES256-SHA"
// "ECDHE-ECDSA-DES-CBC3-SHA"
// "ECDHE-ECDSA-RC4-SHA"
// "ECDHE-RSA-AES128-SHA"
// "ECDHE-RSA-AES256-SHA"
// "ECDHE-RSA-DES-CBC3-SHA"
// "ECDHE-RSA-RC4-SHA"
// "IDEA-CBC-SHA"
// "KRB5-DES-CBC3-MD5"
// "KRB5-DES-CBC3-SHA"
// "KRB5-IDEA-CBC-MD5"
// "KRB5-IDEA-CBC-SHA"
// "KRB5-RC4-MD5"
// "KRB5-RC4-SHA"
// "PSK-3DES-EDE-CBC-SHA"
// "PSK-AES128-CBC-SHA"
// "PSK-AES256-CBC-SHA"
// "PSK-RC4-SHA"
// "RC4-MD5"
// "RC4-SHA"
// "SEED-SHA"
// example: `["ECDHE-RSA-AES256-GCM-SHA384","ECDHE-ECDSA-AES256-GCM-SHA384","ECDHE-RSA-AES128-GCM-SHA256"]`
Ciphers []string `mandatory:"true" json:"ciphers"`
}
func (m SslCipherSuite) String() string
func (m SslCipherSuite) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SslCipherSuiteDetails The configuration details of an SSL cipher suite. The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer (SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to negotiate with peers while sending and receiving information. The cipher suites you use affect the security level, performance, and compatibility of your data traffic. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. Oracle created the following predefined cipher suites that you can specify when you define a resource's SSL configuration (https://docs.cloud.oracle.com/api/#/en/loadbalancer/20170115/datatypes/SSLConfigurationDetails). You can create custom cipher suites (https://docs.cloud.oracle.com/api/#/en/loadbalancer/20170115/SSLCipherSuite/CreateSSLCipherSuite) if the predefined cipher suites do not meet your requirements.
- __oci-default-ssl-cipher-suite-v1__ "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" - __oci-modern-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA384" - __oci-compatible-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" - __oci-wider-compatible-ssl-cipher-suite-v1__ "AES128-GCM-SHA256" "AES128-SHA" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA" "AES256-SHA256" "CAMELLIA128-SHA" "CAMELLIA256-SHA" "DES-CBC3-SHA" "DH-DSS-AES128-GCM-SHA256" "DH-DSS-AES128-SHA" "DH-DSS-AES128-SHA256" "DH-DSS-AES256-GCM-SHA384" "DH-DSS-AES256-SHA" "DH-DSS-AES256-SHA256" "DH-DSS-CAMELLIA128-SHA" "DH-DSS-CAMELLIA256-SHA" "DH-DSS-DES-CBC3-SHAv" "DH-DSS-SEED-SHA" "DH-RSA-AES128-GCM-SHA256" "DH-RSA-AES128-SHA" "DH-RSA-AES128-SHA256" "DH-RSA-AES256-GCM-SHA384" "DH-RSA-AES256-SHA" "DH-RSA-AES256-SHA256" "DH-RSA-CAMELLIA128-SHA" "DH-RSA-CAMELLIA256-SHA" "DH-RSA-DES-CBC3-SHA" "DH-RSA-SEED-SHA" "DHE-DSS-AES128-GCM-SHA256" "DHE-DSS-AES128-SHA" "DHE-DSS-AES128-SHA256" "DHE-DSS-AES256-GCM-SHA384" "DHE-DSS-AES256-SHA" "DHE-DSS-AES256-SHA256" "DHE-DSS-CAMELLIA128-SHA" "DHE-DSS-CAMELLIA256-SHA" "DHE-DSS-DES-CBC3-SHA" "DHE-DSS-SEED-SHA" "DHE-RSA-AES128-GCM-SHA256" "DHE-RSA-AES128-SHA" "DHE-RSA-AES128-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES256-SHA" "DHE-RSA-AES256-SHA256" "DHE-RSA-CAMELLIA128-SHA" "DHE-RSA-CAMELLIA256-SHA" "DHE-RSA-DES-CBC3-SHA" "DHE-RSA-SEED-SHA" "ECDH-ECDSA-AES128-GCM-SHA256" "ECDH-ECDSA-AES128-SHA" "ECDH-ECDSA-AES128-SHA256" "ECDH-ECDSA-AES256-GCM-SHA384" "ECDH-ECDSA-AES256-SHA" "ECDH-ECDSA-AES256-SHA384" "ECDH-ECDSA-DES-CBC3-SHA" "ECDH-ECDSA-RC4-SHA" "ECDH-RSA-AES128-GCM-SHA256" "ECDH-RSA-AES128-SHA" "ECDH-RSA-AES128-SHA256" "ECDH-RSA-AES256-GCM-SHA384" "ECDH-RSA-AES256-SHA" "ECDH-RSA-AES256-SHA384" "ECDH-RSA-DES-CBC3-SHA" "ECDH-RSA-RC4-SHA" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-ECDSA-DES-CBC3-SHA" "ECDHE-ECDSA-RC4-SHA" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES128-SHA256" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-SHA" "ECDHE-RSA-AES256-SHA384" "ECDHE-RSA-DES-CBC3-SHA" "ECDHE-RSA-RC4-SHA" "IDEA-CBC-SHA" "KRB5-DES-CBC3-MD5" "KRB5-DES-CBC3-SHA" "KRB5-IDEA-CBC-MD5" "KRB5-IDEA-CBC-SHA" "KRB5-RC4-MD5" "KRB5-RC4-SHA" "PSK-3DES-EDE-CBC-SHA" "PSK-AES128-CBC-SHA" "PSK-AES256-CBC-SHA" "PSK-RC4-SHA" "RC4-MD5" "RC4-SHA" "SEED-SHA" - __oci-default-http2-ssl-cipher-suite-v1__ "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES128-GCM-SHA256" - __oci-default-http2-tls-13-ssl-cipher-suite-v1__ "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" - __oci-default-http2-tls-12-13-ssl-cipher-suite-v1__ "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "DHE-RSA-AES256-GCM-SHA384" "DHE-RSA-AES128-GCM-SHA256" "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" - __oci-tls-13-recommended-ssl-cipher-suite-v1__ "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" - __oci-tls-12-13-wider-ssl-cipher-suite-v1__ "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES256-SHA384" "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" - __oci-tls-11-12-13-wider-ssl-cipher-suite-v1__ "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" "ECDHE-ECDSA-AES128-GCM-SHA256" "ECDHE-RSA-AES128-GCM-SHA256" "ECDHE-ECDSA-AES128-SHA256" "ECDHE-RSA-AES128-SHA256" "ECDHE-ECDSA-AES256-GCM-SHA384" "ECDHE-RSA-AES256-GCM-SHA384" "ECDHE-ECDSA-AES256-SHA384" "ECDHE-RSA-AES256-SHA384" "AES128-GCM-SHA256" "AES128-SHA256" "AES256-GCM-SHA384" "AES256-SHA256" "ECDHE-ECDSA-AES128-SHA" "ECDHE-RSA-AES128-SHA" "ECDHE-RSA-AES256-SHA" "ECDHE-ECDSA-AES256-SHA" "AES128-SHA" "AES256-SHA"
type SslCipherSuiteDetails struct {
// A friendly name for the SSL cipher suite. It must be unique and it cannot be changed.
// **Note:** The name of your user-defined cipher suite must not be the same as any of Oracle's predefined or
// reserved SSL cipher suite names:
// * oci-default-ssl-cipher-suite-v1
// * oci-modern-ssl-cipher-suite-v1
// * oci-compatible-ssl-cipher-suite-v1
// * oci-wider-compatible-ssl-cipher-suite-v1
// * oci-customized-ssl-cipher-suite
// * oci-default-http2-ssl-cipher-suite-v1
// * oci-default-http2-tls-13-ssl-cipher-suite-v1
// * oci-default-http2-tls-12-13-ssl-cipher-suite-v1
// * oci-tls-13-recommended-ssl-cipher-suite-v1
// * oci-tls-12-13-wider-ssl-cipher-suite-v1
// * oci-tls-11-12-13-wider-ssl-cipher-suite-v1
// example: `example_cipher_suite`
Name *string `mandatory:"true" json:"name"`
// A list of SSL ciphers the load balancer must support for HTTPS or SSL connections.
// The following ciphers are valid values for this property:
// * __TLSv1.3 ciphers__
// "TLS-AES-128-GCM-SHA256"
// "TLS-AES-256-GCM-SHA384"
// "TLS-CHACHA20-POLY1305-SHA256"
// "TLS-AES-128-CCM-SHA256"
// "TLS-AES-128-CCM-8-SHA256"
// * __TLSv1.2 ciphers__
// "AES128-GCM-SHA256"
// "AES128-SHA256"
// "AES256-GCM-SHA384"
// "AES256-SHA256"
// "DH-DSS-AES128-GCM-SHA256"
// "DH-DSS-AES128-SHA256"
// "DH-DSS-AES256-GCM-SHA384"
// "DH-DSS-AES256-SHA256"
// "DH-RSA-AES128-GCM-SHA256"
// "DH-RSA-AES128-SHA256"
// "DH-RSA-AES256-GCM-SHA384"
// "DH-RSA-AES256-SHA256"
// "DHE-DSS-AES128-GCM-SHA256"
// "DHE-DSS-AES128-SHA256"
// "DHE-DSS-AES256-GCM-SHA384"
// "DHE-DSS-AES256-SHA256"
// "DHE-RSA-AES128-GCM-SHA256"
// "DHE-RSA-AES128-SHA256"
// "DHE-RSA-AES256-GCM-SHA384"
// "DHE-RSA-AES256-SHA256"
// "ECDH-ECDSA-AES128-GCM-SHA256"
// "ECDH-ECDSA-AES128-SHA256"
// "ECDH-ECDSA-AES256-GCM-SHA384"
// "ECDH-ECDSA-AES256-SHA384"
// "ECDH-RSA-AES128-GCM-SHA256"
// "ECDH-RSA-AES128-SHA256"
// "ECDH-RSA-AES256-GCM-SHA384"
// "ECDH-RSA-AES256-SHA384"
// "ECDHE-ECDSA-AES128-GCM-SHA256"
// "ECDHE-ECDSA-AES128-SHA256"
// "ECDHE-ECDSA-AES256-GCM-SHA384"
// "ECDHE-ECDSA-AES256-SHA384"
// "ECDHE-RSA-AES128-GCM-SHA256"
// "ECDHE-RSA-AES128-SHA256"
// "ECDHE-RSA-AES256-GCM-SHA384"
// "ECDHE-RSA-AES256-SHA384"
// * __TLSv1 ciphers also supported by TLSv1.2__
// "AES128-SHA"
// "AES256-SHA"
// "CAMELLIA128-SHA"
// "CAMELLIA256-SHA"
// "DES-CBC3-SHA"
// "DH-DSS-AES128-SHA"
// "DH-DSS-AES256-SHA"
// "DH-DSS-CAMELLIA128-SHA"
// "DH-DSS-CAMELLIA256-SHA"
// "DH-DSS-DES-CBC3-SHAv"
// "DH-DSS-SEED-SHA"
// "DH-RSA-AES128-SHA"
// "DH-RSA-AES256-SHA"
// "DH-RSA-CAMELLIA128-SHA"
// "DH-RSA-CAMELLIA256-SHA"
// "DH-RSA-DES-CBC3-SHA"
// "DH-RSA-SEED-SHA"
// "DHE-DSS-AES128-SHA"
// "DHE-DSS-AES256-SHA"
// "DHE-DSS-CAMELLIA128-SHA"
// "DHE-DSS-CAMELLIA256-SHA"
// "DHE-DSS-DES-CBC3-SHA"
// "DHE-DSS-SEED-SHA"
// "DHE-RSA-AES128-SHA"
// "DHE-RSA-AES256-SHA"
// "DHE-RSA-CAMELLIA128-SHA"
// "DHE-RSA-CAMELLIA256-SHA"
// "DHE-RSA-DES-CBC3-SHA"
// "DHE-RSA-SEED-SHA"
// "ECDH-ECDSA-AES128-SHA"
// "ECDH-ECDSA-AES256-SHA"
// "ECDH-ECDSA-DES-CBC3-SHA"
// "ECDH-ECDSA-RC4-SHA"
// "ECDH-RSA-AES128-SHA"
// "ECDH-RSA-AES256-SHA"
// "ECDH-RSA-DES-CBC3-SHA"
// "ECDH-RSA-RC4-SHA"
// "ECDHE-ECDSA-AES128-SHA"
// "ECDHE-ECDSA-AES256-SHA"
// "ECDHE-ECDSA-DES-CBC3-SHA"
// "ECDHE-ECDSA-RC4-SHA"
// "ECDHE-RSA-AES128-SHA"
// "ECDHE-RSA-AES256-SHA"
// "ECDHE-RSA-DES-CBC3-SHA"
// "ECDHE-RSA-RC4-SHA"
// "IDEA-CBC-SHA"
// "KRB5-DES-CBC3-MD5"
// "KRB5-DES-CBC3-SHA"
// "KRB5-IDEA-CBC-MD5"
// "KRB5-IDEA-CBC-SHA"
// "KRB5-RC4-MD5"
// "KRB5-RC4-SHA"
// "PSK-3DES-EDE-CBC-SHA"
// "PSK-AES128-CBC-SHA"
// "PSK-AES256-CBC-SHA"
// "PSK-RC4-SHA"
// "RC4-MD5"
// "RC4-SHA"
// "SEED-SHA"
// example: `["ECDHE-RSA-AES256-GCM-SHA384","ECDHE-ECDSA-AES256-GCM-SHA384","ECDHE-RSA-AES128-GCM-SHA256"]`
Ciphers []string `mandatory:"true" json:"ciphers"`
}
func (m SslCipherSuiteDetails) String() string
func (m SslCipherSuiteDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
type SslConfiguration struct {
// The maximum depth for peer certificate chain verification.
// Example: `3`
VerifyDepth *int `mandatory:"true" json:"verifyDepth"`
// Whether the load balancer listener should verify peer certificates.
// Example: `true`
VerifyPeerCertificate *bool `mandatory:"true" json:"verifyPeerCertificate"`
// Ids for OCI certificates service CA or CA bundles for the load balancer to trust.
// Example: `[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]`
TrustedCertificateAuthorityIds []string `mandatory:"false" json:"trustedCertificateAuthorityIds"`
// Ids for OCI certificates service certificates. Currently only a single Id may be passed.
// Example: `[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]`
CertificateIds []string `mandatory:"false" json:"certificateIds"`
// 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:"false" json:"certificateName"`
// When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client
// ciphers.
// **Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This
// field is ignored when the `SSLConfiguration` object is associated with a backend set.
ServerOrderPreference SslConfigurationServerOrderPreferenceEnum `mandatory:"false" json:"serverOrderPreference,omitempty"`
// The name of the cipher suite to use for HTTPS or SSL connections.
// If this field is not specified, the default is `oci-default-ssl-cipher-suite-v1`.
// **Notes:**
// * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher
// suite. Clients cannot perform an SSL handshake if there is an incompatible configuration.
// * You must ensure compatibility between the ciphers configured in the cipher suite and the configured
// certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA
// certificates.
// * If the cipher configuration is not modified after load balancer creation, the `GET` operation returns
// `oci-default-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing listeners
// that predate this feature.
// * If the cipher configuration was modified using Oracle operations after load balancer creation, the `GET`
// operation returns `oci-customized-ssl-cipher-suite` as the value of this field in the SSL configuration for
// existing listeners that predate this feature.
// * The `GET` operation returns `oci-wider-compatible-ssl-cipher-suite-v1` as the value of this field in the SSL
// configuration for existing backend sets that predate this feature.
// * If the `GET` operation on a listener returns `oci-customized-ssl-cipher-suite` as the value of this field,
// you must specify an appropriate predefined or custom cipher suite name when updating the resource.
// * The `oci-customized-ssl-cipher-suite` Oracle reserved cipher suite name is not accepted as valid input for
// this field.
// example: `example_cipher_suite`
CipherSuiteName *string `mandatory:"false" json:"cipherSuiteName"`
// A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
// The load balancer uses SSL protocols to establish a secure connection between a client and a server. A secure
// connection ensures that all data passed between the client and the server is private.
// The Load Balancing service supports the following protocols:
// * TLSv1
// * TLSv1.1
// * TLSv1.2
// * TLSv1.3
// If this field is not specified, TLSv1.2 is the default.
// **Warning:** All SSL listeners created on a given port must use the same set of SSL protocols.
// **Notes:**
// * The handshake to establish an SSL connection fails if the client supports none of the specified protocols.
// * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher
// suite.
// * For all existing load balancer listeners and backend sets that predate this feature, the `GET` operation
// displays a list of SSL protocols currently used by those resources.
// example: `["TLSv1.1", "TLSv1.2"]`
Protocols []string `mandatory:"false" json:"protocols"`
}
func (m SslConfiguration) String() string
func (m SslConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
type SslConfigurationDetails struct {
// The maximum depth for peer certificate chain verification.
// Example: `3`
VerifyDepth *int `mandatory:"false" json:"verifyDepth"`
// Whether the load balancer listener should verify peer certificates.
// Example: `true`
VerifyPeerCertificate *bool `mandatory:"false" json:"verifyPeerCertificate"`
// Ids for OCI certificates service CA or CA bundles for the load balancer to trust.
// Example: `[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]`
TrustedCertificateAuthorityIds []string `mandatory:"false" json:"trustedCertificateAuthorityIds"`
// Ids for OCI certificates service certificates. Currently only a single Id may be passed.
// Example: `[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]`
CertificateIds []string `mandatory:"false" json:"certificateIds"`
// 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:"false" json:"certificateName"`
// A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
// The load balancer uses SSL protocols to establish a secure connection between a client and a server. A secure
// connection ensures that all data passed between the client and the server is private.
// The Load Balancing service supports the following protocols:
// * TLSv1
// * TLSv1.1
// * TLSv1.2
// * TLSv1.3
// If this field is not specified, TLSv1.2 is the default.
// **Warning:** All SSL listeners created on a given port must use the same set of SSL protocols.
// **Notes:**
// * The handshake to establish an SSL connection fails if the client supports none of the specified protocols.
// * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher
// suite.
// * For all existing load balancer listeners and backend sets that predate this feature, the `GET` operation
// displays a list of SSL protocols currently used by those resources.
// example: `["TLSv1.1", "TLSv1.2"]`
Protocols []string `mandatory:"false" json:"protocols"`
// The name of the cipher suite to use for HTTPS or SSL connections.
// If this field is not specified, the default is `oci-default-ssl-cipher-suite-v1`.
// **Notes:**
// * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher
// suite. Clients cannot perform an SSL handshake if there is an incompatible configuration.
// * You must ensure compatibility between the ciphers configured in the cipher suite and the configured
// certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA
// certificates.
// * If the cipher configuration is not modified after load balancer creation, the `GET` operation returns
// `oci-default-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing listeners
// that predate this feature.
// * If the cipher configuration was modified using Oracle operations after load balancer creation, the `GET`
// operation returns `oci-customized-ssl-cipher-suite` as the value of this field in the SSL configuration for
// existing listeners that predate this feature.
// * The `GET` operation returns `oci-wider-compatible-ssl-cipher-suite-v1` as the value of this field in the SSL
// configuration for existing backend sets that predate this feature.
// * If the `GET` operation on a listener returns `oci-customized-ssl-cipher-suite` as the value of this field,
// you must specify an appropriate predefined or custom cipher suite name when updating the resource.
// * The `oci-customized-ssl-cipher-suite` Oracle reserved cipher suite name is not accepted as valid input for
// this field.
// example: `example_cipher_suite`
CipherSuiteName *string `mandatory:"false" json:"cipherSuiteName"`
// When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client
// ciphers.
// **Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This
// field is ignored when the `SSLConfiguration` object is associated with a backend set.
ServerOrderPreference SslConfigurationDetailsServerOrderPreferenceEnum `mandatory:"false" json:"serverOrderPreference,omitempty"`
}
func (m SslConfigurationDetails) String() string
func (m SslConfigurationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SslConfigurationDetailsServerOrderPreferenceEnum Enum with underlying type: string
type SslConfigurationDetailsServerOrderPreferenceEnum string
Set of constants representing the allowable values for SslConfigurationDetailsServerOrderPreferenceEnum
const (
SslConfigurationDetailsServerOrderPreferenceEnabled SslConfigurationDetailsServerOrderPreferenceEnum = "ENABLED"
SslConfigurationDetailsServerOrderPreferenceDisabled SslConfigurationDetailsServerOrderPreferenceEnum = "DISABLED"
)
func GetMappingSslConfigurationDetailsServerOrderPreferenceEnum(val string) (SslConfigurationDetailsServerOrderPreferenceEnum, bool)
GetMappingSslConfigurationDetailsServerOrderPreferenceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSslConfigurationDetailsServerOrderPreferenceEnumValues() []SslConfigurationDetailsServerOrderPreferenceEnum
GetSslConfigurationDetailsServerOrderPreferenceEnumValues Enumerates the set of values for SslConfigurationDetailsServerOrderPreferenceEnum
SslConfigurationServerOrderPreferenceEnum Enum with underlying type: string
type SslConfigurationServerOrderPreferenceEnum string
Set of constants representing the allowable values for SslConfigurationServerOrderPreferenceEnum
const (
SslConfigurationServerOrderPreferenceEnabled SslConfigurationServerOrderPreferenceEnum = "ENABLED"
SslConfigurationServerOrderPreferenceDisabled SslConfigurationServerOrderPreferenceEnum = "DISABLED"
)
func GetMappingSslConfigurationServerOrderPreferenceEnum(val string) (SslConfigurationServerOrderPreferenceEnum, bool)
GetMappingSslConfigurationServerOrderPreferenceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSslConfigurationServerOrderPreferenceEnumValues() []SslConfigurationServerOrderPreferenceEnum
GetSslConfigurationServerOrderPreferenceEnumValues Enumerates the set of values for SslConfigurationServerOrderPreferenceEnum
UpdateBackendDetails The configuration details for updating a backend server.
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"`
}
func (m UpdateBackendDetails) String() string
func (m UpdateBackendDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateBackendRequest wrapper for the UpdateBackend operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateBackend.go.html to see an example of how to use UpdateBackendRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request UpdateBackendRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateBackendRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBackendRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBackendRequest) String() string
func (request UpdateBackendRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateBackendResponse wrapper for the UpdateBackend operation
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"`
}
func (response UpdateBackendResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBackendResponse) String() string
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.
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"`
}
func (m UpdateBackendSetDetails) String() string
func (m UpdateBackendSetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateBackendSetRequest wrapper for the UpdateBackendSet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateBackendSet.go.html to see an example of how to use UpdateBackendSetRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request UpdateBackendSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateBackendSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBackendSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBackendSetRequest) String() string
func (request UpdateBackendSetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateBackendSetResponse wrapper for the UpdateBackendSet operation
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"`
}
func (response UpdateBackendSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBackendSetResponse) String() string
UpdateHealthCheckerDetails The health checker's configuration details.
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"`
// Specifies if health checks should always be done using plain text instead of depending on
// whether or not the associated backend set is using SSL.
// If "true", health checks will be done using plain text even if the associated backend set is configured
// to use SSL.
// If "false", health checks will be done using SSL encryption if the associated backend set is configured
// to use SSL. If the backend set is not so configured the health checks will be done using plain text.
// Example: `true`
IsForcePlainText *bool `mandatory:"false" json:"isForcePlainText"`
}
func (m UpdateHealthCheckerDetails) String() string
func (m UpdateHealthCheckerDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateHealthCheckerRequest wrapper for the UpdateHealthChecker operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateHealthChecker.go.html to see an example of how to use UpdateHealthCheckerRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request UpdateHealthCheckerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateHealthCheckerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateHealthCheckerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateHealthCheckerRequest) String() string
func (request UpdateHealthCheckerRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateHealthCheckerResponse wrapper for the UpdateHealthChecker operation
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"`
}
func (response UpdateHealthCheckerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateHealthCheckerResponse) String() string
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).
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"`
}
func (m UpdateHostnameDetails) String() string
func (m UpdateHostnameDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateHostnameRequest wrapper for the UpdateHostname operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateHostname.go.html to see an example of how to use UpdateHostnameRequest.
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"`
// 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. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request UpdateHostnameRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateHostnameRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateHostnameRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateHostnameRequest) String() string
func (request UpdateHostnameRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateHostnameResponse wrapper for the UpdateHostname operation
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"`
}
func (response UpdateHostnameResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateHostnameResponse) String() string
UpdateListenerDetails The configuration details for updating a listener.
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"`
// Deprecated. Please use `routingPolicies` instead.
// 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"`
// The name of the routing policy applied to this listener's traffic.
// Example: `example_routing_policy`
RoutingPolicyName *string `mandatory:"false" json:"routingPolicyName"`
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"`
}
func (m UpdateListenerDetails) String() string
func (m UpdateListenerDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateListenerRequest wrapper for the UpdateListener operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateListener.go.html to see an example of how to use UpdateListenerRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request UpdateListenerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateListenerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateListenerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateListenerRequest) String() string
func (request UpdateListenerRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateListenerResponse wrapper for the UpdateListener operation
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"`
}
func (response UpdateListenerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateListenerResponse) String() string
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.
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"`
}
func (m UpdateLoadBalancerDetails) String() string
func (m UpdateLoadBalancerDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateLoadBalancerRequest wrapper for the UpdateLoadBalancer operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateLoadBalancer.go.html to see an example of how to use UpdateLoadBalancerRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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"`
// 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
}
func (request UpdateLoadBalancerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateLoadBalancerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateLoadBalancerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateLoadBalancerRequest) String() string
func (request UpdateLoadBalancerRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateLoadBalancerResponse wrapper for the UpdateLoadBalancer operation
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"`
}
func (response UpdateLoadBalancerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateLoadBalancerResponse) String() string
UpdateLoadBalancerShapeDetails The representation of UpdateLoadBalancerShapeDetails
type UpdateLoadBalancerShapeDetails struct {
// The new shape name for the load balancer.
// Allowed values are :
// * 10Mbps
// * 100Mbps
// * 400Mbps
// * 8000Mbps
// * Flexible
// Example: `flexible`
// * NOTE: Fixed shapes 10Mbps, 100Mbps, 400Mbps, 8000Mbps will be deprecated from May 2023. This api
// * will only support `Flexible` shape after that date.
ShapeName *string `mandatory:"true" json:"shapeName"`
// The configuration details to update load balancer to a different profile.
ShapeDetails *ShapeDetails `mandatory:"false" json:"shapeDetails"`
}
func (m UpdateLoadBalancerShapeDetails) String() string
func (m UpdateLoadBalancerShapeDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateLoadBalancerShapeRequest wrapper for the UpdateLoadBalancerShape operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateLoadBalancerShape.go.html to see an example of how to use UpdateLoadBalancerShapeRequest.
type UpdateLoadBalancerShapeRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer whose shape will be updated.
LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`
// The details for updating a load balancer's shape. This contains the new, desired shape.
UpdateLoadBalancerShapeDetails `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. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request UpdateLoadBalancerShapeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateLoadBalancerShapeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateLoadBalancerShapeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateLoadBalancerShapeRequest) String() string
func (request UpdateLoadBalancerShapeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateLoadBalancerShapeResponse wrapper for the UpdateLoadBalancerShape operation
type UpdateLoadBalancerShapeResponse 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"`
}
func (response UpdateLoadBalancerShapeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateLoadBalancerShapeResponse) String() string
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.
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"`
}
func (m UpdateNetworkSecurityGroupsDetails) String() string
func (m UpdateNetworkSecurityGroupsDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateNetworkSecurityGroupsRequest wrapper for the UpdateNetworkSecurityGroups operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateNetworkSecurityGroups.go.html to see an example of how to use UpdateNetworkSecurityGroupsRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request UpdateNetworkSecurityGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateNetworkSecurityGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateNetworkSecurityGroupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateNetworkSecurityGroupsRequest) String() string
func (request UpdateNetworkSecurityGroupsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateNetworkSecurityGroupsResponse wrapper for the UpdateNetworkSecurityGroups operation
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"`
}
func (response UpdateNetworkSecurityGroupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateNetworkSecurityGroupsResponse) String() string
UpdatePathRouteSetDetails An updated set of path route rules that overwrites the existing set of rules.
type UpdatePathRouteSetDetails struct {
// The set of path route rules.
PathRoutes []PathRoute `mandatory:"true" json:"pathRoutes"`
}
func (m UpdatePathRouteSetDetails) String() string
func (m UpdatePathRouteSetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePathRouteSetRequest wrapper for the UpdatePathRouteSet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdatePathRouteSet.go.html to see an example of how to use UpdatePathRouteSetRequest.
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"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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"`
// 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
}
func (request UpdatePathRouteSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePathRouteSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePathRouteSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePathRouteSetRequest) String() string
func (request UpdatePathRouteSetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePathRouteSetResponse wrapper for the UpdatePathRouteSet operation
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"`
}
func (response UpdatePathRouteSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePathRouteSetResponse) String() string
UpdateRoutingPolicyDetails An updated list of routing rules that overwrites the existing list of routing rules.
type UpdateRoutingPolicyDetails struct {
// The list of routing rules.
Rules []RoutingRule `mandatory:"true" json:"rules"`
// The version of the language in which `condition` of `rules` are composed.
ConditionLanguageVersion UpdateRoutingPolicyDetailsConditionLanguageVersionEnum `mandatory:"false" json:"conditionLanguageVersion,omitempty"`
}
func (m UpdateRoutingPolicyDetails) String() string
func (m UpdateRoutingPolicyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateRoutingPolicyDetailsConditionLanguageVersionEnum Enum with underlying type: string
type UpdateRoutingPolicyDetailsConditionLanguageVersionEnum string
Set of constants representing the allowable values for UpdateRoutingPolicyDetailsConditionLanguageVersionEnum
const (
UpdateRoutingPolicyDetailsConditionLanguageVersionV1 UpdateRoutingPolicyDetailsConditionLanguageVersionEnum = "V1"
)
func GetMappingUpdateRoutingPolicyDetailsConditionLanguageVersionEnum(val string) (UpdateRoutingPolicyDetailsConditionLanguageVersionEnum, bool)
GetMappingUpdateRoutingPolicyDetailsConditionLanguageVersionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateRoutingPolicyDetailsConditionLanguageVersionEnumValues() []UpdateRoutingPolicyDetailsConditionLanguageVersionEnum
GetUpdateRoutingPolicyDetailsConditionLanguageVersionEnumValues Enumerates the set of values for UpdateRoutingPolicyDetailsConditionLanguageVersionEnum
UpdateRoutingPolicyRequest wrapper for the UpdateRoutingPolicy operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateRoutingPolicy.go.html to see an example of how to use UpdateRoutingPolicyRequest.
type UpdateRoutingPolicyRequest struct {
// The configuration details needed to update a routing policy.
UpdateRoutingPolicyDetails `contributesTo:"body"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policy to update.
LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`
// The name of the routing policy to update.
// Example: `example_routing_policy_name`
RoutingPolicyName *string `mandatory:"true" contributesTo:"path" name:"routingPolicyName"`
// 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 optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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"`
// 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
}
func (request UpdateRoutingPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRoutingPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRoutingPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRoutingPolicyRequest) String() string
func (request UpdateRoutingPolicyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateRoutingPolicyResponse wrapper for the UpdateRoutingPolicy operation
type UpdateRoutingPolicyResponse 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"`
}
func (response UpdateRoutingPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRoutingPolicyResponse) String() string
UpdateRuleSetDetails An updated set of rules that overwrites the existing set of rules.
type UpdateRuleSetDetails struct {
// An array of rules that compose the rule set.
Items []Rule `mandatory:"true" json:"items"`
}
func (m UpdateRuleSetDetails) String() string
func (m *UpdateRuleSetDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateRuleSetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateRuleSetRequest wrapper for the UpdateRuleSet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateRuleSet.go.html to see an example of how to use UpdateRuleSetRequest.
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"`
// 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. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request UpdateRuleSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRuleSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRuleSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRuleSetRequest) String() string
func (request UpdateRuleSetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateRuleSetResponse wrapper for the UpdateRuleSet operation
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"`
}
func (response UpdateRuleSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRuleSetResponse) String() string
UpdateSSLCipherSuiteRequest wrapper for the UpdateSSLCipherSuite operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/loadbalancer/UpdateSSLCipherSuite.go.html to see an example of how to use UpdateSSLCipherSuiteRequest.
type UpdateSSLCipherSuiteRequest struct {
// The configuration details to update an SSL cipher suite.
UpdateSslCipherSuiteDetails `contributesTo:"body"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the associated load balancer.
LoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"loadBalancerId"`
// The name of the SSL cipher suite to update.
// example: `example_cipher_suite`
Name *string `mandatory:"true" contributesTo:"path" name:"name"`
// 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. In the PUT or DELETE call for a resource, set the if-match
// parameter to the value of the ETag for the load balancer. This value can be obtained from a GET
// or POST response for any resource of that load balancer.
// For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.
// The resource is updated or deleted 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
}
func (request UpdateSSLCipherSuiteRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSSLCipherSuiteRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSSLCipherSuiteRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSSLCipherSuiteRequest) String() string
func (request UpdateSSLCipherSuiteRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSSLCipherSuiteResponse wrapper for the UpdateSSLCipherSuite operation
type UpdateSSLCipherSuiteResponse 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"`
}
func (response UpdateSSLCipherSuiteResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSSLCipherSuiteResponse) String() string
UpdateSslCipherSuiteDetails The configuration details for updating an SSL cipher suite. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type UpdateSslCipherSuiteDetails struct {
// A list of SSL ciphers the load balancer must support for HTTPS or SSL connections.
// The following ciphers are valid values for this property:
// * __TLSv1.3 ciphers__
// "TLS-AES-128-GCM-SHA256"
// "TLS-AES-256-GCM-SHA384"
// "TLS-CHACHA20-POLY1305-SHA256"
// "TLS-AES-128-CCM-SHA256"
// "TLS-AES-128-CCM-8-SHA256"
// * __TLSv1.2 ciphers__
// "AES128-GCM-SHA256"
// "AES128-SHA256"
// "AES256-GCM-SHA384"
// "AES256-SHA256"
// "DH-DSS-AES128-GCM-SHA256"
// "DH-DSS-AES128-SHA256"
// "DH-DSS-AES256-GCM-SHA384"
// "DH-DSS-AES256-SHA256"
// "DH-RSA-AES128-GCM-SHA256"
// "DH-RSA-AES128-SHA256"
// "DH-RSA-AES256-GCM-SHA384"
// "DH-RSA-AES256-SHA256"
// "DHE-DSS-AES128-GCM-SHA256"
// "DHE-DSS-AES128-SHA256"
// "DHE-DSS-AES256-GCM-SHA384"
// "DHE-DSS-AES256-SHA256"
// "DHE-RSA-AES128-GCM-SHA256"
// "DHE-RSA-AES128-SHA256"
// "DHE-RSA-AES256-GCM-SHA384"
// "DHE-RSA-AES256-SHA256"
// "ECDH-ECDSA-AES128-GCM-SHA256"
// "ECDH-ECDSA-AES128-SHA256"
// "ECDH-ECDSA-AES256-GCM-SHA384"
// "ECDH-ECDSA-AES256-SHA384"
// "ECDH-RSA-AES128-GCM-SHA256"
// "ECDH-RSA-AES128-SHA256"
// "ECDH-RSA-AES256-GCM-SHA384"
// "ECDH-RSA-AES256-SHA384"
// "ECDHE-ECDSA-AES128-GCM-SHA256"
// "ECDHE-ECDSA-AES128-SHA256"
// "ECDHE-ECDSA-AES256-GCM-SHA384"
// "ECDHE-ECDSA-AES256-SHA384"
// "ECDHE-RSA-AES128-GCM-SHA256"
// "ECDHE-RSA-AES128-SHA256"
// "ECDHE-RSA-AES256-GCM-SHA384"
// "ECDHE-RSA-AES256-SHA384"
// * __TLSv1 ciphers also supported by TLSv1.2__
// "AES128-SHA"
// "AES256-SHA"
// "CAMELLIA128-SHA"
// "CAMELLIA256-SHA"
// "DES-CBC3-SHA"
// "DH-DSS-AES128-SHA"
// "DH-DSS-AES256-SHA"
// "DH-DSS-CAMELLIA128-SHA"
// "DH-DSS-CAMELLIA256-SHA"
// "DH-DSS-DES-CBC3-SHAv"
// "DH-DSS-SEED-SHA"
// "DH-RSA-AES128-SHA"
// "DH-RSA-AES256-SHA"
// "DH-RSA-CAMELLIA128-SHA"
// "DH-RSA-CAMELLIA256-SHA"
// "DH-RSA-DES-CBC3-SHA"
// "DH-RSA-SEED-SHA"
// "DHE-DSS-AES128-SHA"
// "DHE-DSS-AES256-SHA"
// "DHE-DSS-CAMELLIA128-SHA"
// "DHE-DSS-CAMELLIA256-SHA"
// "DHE-DSS-DES-CBC3-SHA"
// "DHE-DSS-SEED-SHA"
// "DHE-RSA-AES128-SHA"
// "DHE-RSA-AES256-SHA"
// "DHE-RSA-CAMELLIA128-SHA"
// "DHE-RSA-CAMELLIA256-SHA"
// "DHE-RSA-DES-CBC3-SHA"
// "DHE-RSA-SEED-SHA"
// "ECDH-ECDSA-AES128-SHA"
// "ECDH-ECDSA-AES256-SHA"
// "ECDH-ECDSA-DES-CBC3-SHA"
// "ECDH-ECDSA-RC4-SHA"
// "ECDH-RSA-AES128-SHA"
// "ECDH-RSA-AES256-SHA"
// "ECDH-RSA-DES-CBC3-SHA"
// "ECDH-RSA-RC4-SHA"
// "ECDHE-ECDSA-AES128-SHA"
// "ECDHE-ECDSA-AES256-SHA"
// "ECDHE-ECDSA-DES-CBC3-SHA"
// "ECDHE-ECDSA-RC4-SHA"
// "ECDHE-RSA-AES128-SHA"
// "ECDHE-RSA-AES256-SHA"
// "ECDHE-RSA-DES-CBC3-SHA"
// "ECDHE-RSA-RC4-SHA"
// "IDEA-CBC-SHA"
// "KRB5-DES-CBC3-MD5"
// "KRB5-DES-CBC3-SHA"
// "KRB5-IDEA-CBC-MD5"
// "KRB5-IDEA-CBC-SHA"
// "KRB5-RC4-MD5"
// "KRB5-RC4-SHA"
// "PSK-3DES-EDE-CBC-SHA"
// "PSK-AES128-CBC-SHA"
// "PSK-AES256-CBC-SHA"
// "PSK-RC4-SHA"
// "RC4-MD5"
// "RC4-SHA"
// "SEED-SHA"
// example: `["ECDHE-RSA-AES256-GCM-SHA384","ECDHE-ECDSA-AES256-GCM-SHA384","ECDHE-RSA-AES128-GCM-SHA256"]`
Ciphers []string `mandatory:"true" json:"ciphers"`
}
func (m UpdateSslCipherSuiteDetails) String() string
func (m UpdateSslCipherSuiteDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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).
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 OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// 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"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An object returned in the event of a work request error.
type WorkRequestError struct {
ErrorCode WorkRequestErrorErrorCodeEnum `mandatory:"true" json:"errorCode"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorErrorCodeEnum Enum with underlying type: string
type WorkRequestErrorErrorCodeEnum string
Set of constants representing the allowable values for WorkRequestErrorErrorCodeEnum
const (
WorkRequestErrorErrorCodeBadInput WorkRequestErrorErrorCodeEnum = "BAD_INPUT"
WorkRequestErrorErrorCodeInternalError WorkRequestErrorErrorCodeEnum = "INTERNAL_ERROR"
)
func GetMappingWorkRequestErrorErrorCodeEnum(val string) (WorkRequestErrorErrorCodeEnum, bool)
GetMappingWorkRequestErrorErrorCodeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestErrorErrorCodeEnumValues() []WorkRequestErrorErrorCodeEnum
GetWorkRequestErrorErrorCodeEnumValues Enumerates the set of values for WorkRequestErrorErrorCodeEnum
WorkRequestLifecycleStateEnum Enum with underlying type: string
type WorkRequestLifecycleStateEnum string
Set of constants representing the allowable values for WorkRequestLifecycleStateEnum
const (
WorkRequestLifecycleStateAccepted WorkRequestLifecycleStateEnum = "ACCEPTED"
WorkRequestLifecycleStateInProgress WorkRequestLifecycleStateEnum = "IN_PROGRESS"
WorkRequestLifecycleStateFailed WorkRequestLifecycleStateEnum = "FAILED"
WorkRequestLifecycleStateSucceeded WorkRequestLifecycleStateEnum = "SUCCEEDED"
)
func GetMappingWorkRequestLifecycleStateEnum(val string) (WorkRequestLifecycleStateEnum, bool)
GetMappingWorkRequestLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestLifecycleStateEnumValues() []WorkRequestLifecycleStateEnum
GetWorkRequestLifecycleStateEnumValues Enumerates the set of values for WorkRequestLifecycleStateEnum