func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
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 GetDnsHealthCheckQueryClassesEnumStringValues() []string
GetDnsHealthCheckQueryClassesEnumStringValues Enumerates the set of values in String for DnsHealthCheckQueryClassesEnum
func GetDnsHealthCheckQueryTypesEnumStringValues() []string
GetDnsHealthCheckQueryTypesEnumStringValues Enumerates the set of values in String for DnsHealthCheckQueryTypesEnum
func GetDnsHealthCheckRCodesEnumStringValues() []string
GetDnsHealthCheckRCodesEnumStringValues Enumerates the set of values in String for DnsHealthCheckRCodesEnum
func GetDnsHealthCheckTransportProtocolsEnumStringValues() []string
GetDnsHealthCheckTransportProtocolsEnumStringValues Enumerates the set of values in String for DnsHealthCheckTransportProtocolsEnum
func GetHcsInfraIpVersionEnumStringValues() []string
GetHcsInfraIpVersionEnumStringValues Enumerates the set of values in String for HcsInfraIpVersionEnum
func GetHealthCheckProtocolsEnumStringValues() []string
GetHealthCheckProtocolsEnumStringValues Enumerates the set of values in String for HealthCheckProtocolsEnum
func GetHealthCheckResultHealthCheckStatusEnumStringValues() []string
GetHealthCheckResultHealthCheckStatusEnumStringValues Enumerates the set of values in String for HealthCheckResultHealthCheckStatusEnum
func GetIpVersionEnumStringValues() []string
GetIpVersionEnumStringValues Enumerates the set of values in String for IpVersionEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetListBackendSetsSortByEnumStringValues() []string
GetListBackendSetsSortByEnumStringValues Enumerates the set of values in String for ListBackendSetsSortByEnum
func GetListBackendSetsSortOrderEnumStringValues() []string
GetListBackendSetsSortOrderEnumStringValues Enumerates the set of values in String for ListBackendSetsSortOrderEnum
func GetListBackendsSortByEnumStringValues() []string
GetListBackendsSortByEnumStringValues Enumerates the set of values in String for ListBackendsSortByEnum
func GetListBackendsSortOrderEnumStringValues() []string
GetListBackendsSortOrderEnumStringValues Enumerates the set of values in String for ListBackendsSortOrderEnum
func GetListListenersSortByEnumStringValues() []string
GetListListenersSortByEnumStringValues Enumerates the set of values in String for ListListenersSortByEnum
func GetListListenersSortOrderEnumStringValues() []string
GetListListenersSortOrderEnumStringValues Enumerates the set of values in String for ListListenersSortOrderEnum
func GetListNetworkLoadBalancerHealthsSortByEnumStringValues() []string
GetListNetworkLoadBalancerHealthsSortByEnumStringValues Enumerates the set of values in String for ListNetworkLoadBalancerHealthsSortByEnum
func GetListNetworkLoadBalancerHealthsSortOrderEnumStringValues() []string
GetListNetworkLoadBalancerHealthsSortOrderEnumStringValues Enumerates the set of values in String for ListNetworkLoadBalancerHealthsSortOrderEnum
func GetListNetworkLoadBalancersLifecycleStateEnumStringValues() []string
GetListNetworkLoadBalancersLifecycleStateEnumStringValues Enumerates the set of values in String for ListNetworkLoadBalancersLifecycleStateEnum
func GetListNetworkLoadBalancersPoliciesSortByEnumStringValues() []string
GetListNetworkLoadBalancersPoliciesSortByEnumStringValues Enumerates the set of values in String for ListNetworkLoadBalancersPoliciesSortByEnum
func GetListNetworkLoadBalancersPoliciesSortOrderEnumStringValues() []string
GetListNetworkLoadBalancersPoliciesSortOrderEnumStringValues Enumerates the set of values in String for ListNetworkLoadBalancersPoliciesSortOrderEnum
func GetListNetworkLoadBalancersProtocolsSortByEnumStringValues() []string
GetListNetworkLoadBalancersProtocolsSortByEnumStringValues Enumerates the set of values in String for ListNetworkLoadBalancersProtocolsSortByEnum
func GetListNetworkLoadBalancersProtocolsSortOrderEnumStringValues() []string
GetListNetworkLoadBalancersProtocolsSortOrderEnumStringValues Enumerates the set of values in String for ListNetworkLoadBalancersProtocolsSortOrderEnum
func GetListNetworkLoadBalancersSortByEnumStringValues() []string
GetListNetworkLoadBalancersSortByEnumStringValues Enumerates the set of values in String for ListNetworkLoadBalancersSortByEnum
func GetListNetworkLoadBalancersSortOrderEnumStringValues() []string
GetListNetworkLoadBalancersSortOrderEnumStringValues Enumerates the set of values in String for ListNetworkLoadBalancersSortOrderEnum
func GetListenerProtocolsEnumStringValues() []string
GetListenerProtocolsEnumStringValues Enumerates the set of values in String for ListenerProtocolsEnum
func GetNetworkLoadBalancerHealthStatusEnumStringValues() []string
GetNetworkLoadBalancerHealthStatusEnumStringValues Enumerates the set of values in String for NetworkLoadBalancerHealthStatusEnum
func GetNetworkLoadBalancerHealthSummaryStatusEnumStringValues() []string
GetNetworkLoadBalancerHealthSummaryStatusEnumStringValues Enumerates the set of values in String for NetworkLoadBalancerHealthSummaryStatusEnum
func GetNetworkLoadBalancersPolicySummaryEnumStringValues() []string
GetNetworkLoadBalancersPolicySummaryEnumStringValues Enumerates the set of values in String for NetworkLoadBalancersPolicySummaryEnum
func GetNetworkLoadBalancersProtocolSummaryEnumStringValues() []string
GetNetworkLoadBalancersProtocolSummaryEnumStringValues Enumerates the set of values in String for NetworkLoadBalancersProtocolSummaryEnum
func GetNetworkLoadBalancingPolicyEnumStringValues() []string
GetNetworkLoadBalancingPolicyEnumStringValues Enumerates the set of values in String for NetworkLoadBalancingPolicyEnum
func GetNlbIpVersionEnumStringValues() []string
GetNlbIpVersionEnumStringValues Enumerates the set of values in String for NlbIpVersionEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Backend The configuration of a backend server that is a member of a network load balancer backend set. For more information, see Managing Backend Servers (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/BackendServers/backend-server-management.htm).
type Backend struct {
// The communication port for the backend server.
// Example: `8080`
Port *int `mandatory:"true" json:"port"`
// A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set.
// Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<var><unique_ID></var>:443` or `10.0.0.3:0`
Name *string `mandatory:"false" json:"name"`
// The IP address of the backend server.
// Example: `10.0.0.3`
IpAddress *string `mandatory:"false" json:"ipAddress"`
// The IP OCID/Instance OCID associated with the backend server.
// Example: `ocid1.privateip..oc1.<var><unique_ID></var>`
TargetId *string `mandatory:"false" json:"targetId"`
// The network 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 three times the number of new connections
// as a server weighted '1'.
// For more information about load balancing policies, see
// How Network Load Balancing Policies Work (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/introducton.htm#Policies).
// Example: `3`
Weight *int `mandatory:"false" json:"weight"`
// Whether the network load balancer should drain this server. Servers marked "isDrain" receive no
// incoming traffic.
// Example: `false`
IsDrain *bool `mandatory:"false" json:"isDrain"`
// Whether the network load balancer should treat this server as a backup unit. If `true`, then the network load balancer forwards no ingress
// traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy.
// Example: `false`
IsBackup *bool `mandatory:"false" json:"isBackup"`
// Whether the network load balancer should treat this server as offline. Offline servers receive no incoming
// traffic.
// Example: `false`
IsOffline *bool `mandatory:"false" json:"isOffline"`
}
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
BackendCollection Wrapper object for an array of BackendSummary objects.
type BackendCollection struct {
// An array of BackendSummary objects.
Items []BackendSummary `mandatory:"false" json:"items"`
}
func (m BackendCollection) String() string
func (m BackendCollection) 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 network network load balancing configuration details of a backend server.
type BackendDetails struct {
// The communication port for the backend server.
// Example: `8080`
Port *int `mandatory:"true" json:"port"`
// A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set.
// Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<var><unique_ID></var>:443` or `10.0.0.3:0`
Name *string `mandatory:"false" json:"name"`
// The IP address of the backend server.
// Example: `10.0.0.3`
IpAddress *string `mandatory:"false" json:"ipAddress"`
// The IP OCID/Instance OCID associated with the backend server.
// Example: `ocid1.privateip..oc1.<var><unique_ID></var>`
TargetId *string `mandatory:"false" json:"targetId"`
// The network 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 three times the number of new connections
// as a server weighted '1'.
// For more information about load balancing policies, see
// How Network Load Balancing Policies Work (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/introducton.htm#Policies).
// Example: `3`
Weight *int `mandatory:"false" json:"weight"`
// Whether the network load balancer should treat this server as a backup unit. If `true`, then the network load balancer forwards no ingress
// traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy.
// Example: `false`
IsBackup *bool `mandatory:"false" json:"isBackup"`
// Whether the network load balancer should drain this server. Servers marked "isDrain" receive no
// incoming traffic.
// Example: `false`
IsDrain *bool `mandatory:"false" json:"isDrain"`
// Whether the network load balancer should treat this server as offline. Offline servers receive no incoming
// traffic.
// Example: `false`
IsOffline *bool `mandatory:"false" json:"isOffline"`
}
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.
type BackendHealth struct {
// The general health status of the specified backend server.
// * **OK:** All health check probes return `OK`
// * **WARNING:** At least one of the health check probes does not return `OK`
// * **CRITICAL:** None of the health check probes return `OK`.
// *
// * **UNKNOWN:** One of the health checks probes return `UNKNOWN`,
// * or the system is 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 network load balancer backend set. For more information about backend set configuration, see Managing Backend Sets (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/BackendSets/backend-set-management.htm). **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type BackendSet struct {
// A user-friendly name for the backend set that must be unique and 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"`
HealthChecker *HealthChecker `mandatory:"true" json:"healthChecker"`
// The network load balancer policy for the backend set.
// Example: `FIVE_TUPLE`
Policy NetworkLoadBalancingPolicyEnum `mandatory:"false" json:"policy,omitempty"`
// If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends.
// Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled.
// The value is true by default.
IsPreserveSource *bool `mandatory:"false" json:"isPreserveSource"`
// If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy.
// The value is false by default.
IsFailOpen *bool `mandatory:"false" json:"isFailOpen"`
// If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
IsInstantFailoverEnabled *bool `mandatory:"false" json:"isInstantFailoverEnabled"`
// IP version associated with the backend set.
IpVersion IpVersionEnum `mandatory:"false" json:"ipVersion,omitempty"`
// Array of backends.
Backends []Backend `mandatory:"false" json:"backends"`
}
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
BackendSetCollection Wrapper object for an array of `BackendSetSummary` objects.
type BackendSetCollection struct {
// An array of `BackendSetSummary` objects.
Items []BackendSetSummary `mandatory:"false" json:"items"`
}
func (m BackendSetCollection) String() string
func (m BackendSetCollection) 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 of a network load balancer backend set. For more information about backend set configuration, see Managing Backend Sets (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/BackendSets/backend-set-management.htm). **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type BackendSetDetails struct {
HealthChecker *HealthChecker `mandatory:"true" json:"healthChecker"`
// The network load balancer policy for the backend set.
// Example: `FIVE_TUPLE`
Policy NetworkLoadBalancingPolicyEnum `mandatory:"false" json:"policy,omitempty"`
// IP version associated with the backend set.
IpVersion IpVersionEnum `mandatory:"false" json:"ipVersion,omitempty"`
// If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends.
// Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled.
// The value is true by default.
IsPreserveSource *bool `mandatory:"false" json:"isPreserveSource"`
// If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy.
// The value is false by default.
IsFailOpen *bool `mandatory:"false" json:"isFailOpen"`
// If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
IsInstantFailoverEnabled *bool `mandatory:"false" json:"isInstantFailoverEnabled"`
// An array of backends.
Backends []Backend `mandatory:"false" json:"backends"`
}
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, the backend sets 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 servers in a backend set 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 servers in a backend set return a status of `OK`.
// * **UNKNOWN:** If no probes have yet been sent to the backends, or the system is
// unable to retrieve metrics from the backends.
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 or OCID and port.
// Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var><unique_ID></var>: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
BackendSetSummary The configuration of a network load balancer backend set. For more information about backend set configuration, see Managing Backend Sets (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/BackendSets/backend-set-management.htm). **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type BackendSetSummary struct {
// A user-friendly name for the backend set that must be unique and 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 network load balancer policy for the backend set.
// Example: `FIVE_TUPLE`
Policy NetworkLoadBalancingPolicyEnum `mandatory:"true" json:"policy"`
// An array of backends.
Backends []Backend `mandatory:"true" json:"backends"`
HealthChecker *HealthChecker `mandatory:"true" json:"healthChecker"`
// If this parameter is enabled, the network load balancer preserves the source IP of the packet forwarded to the backend servers.
// Backend servers see the original source IP. If the `isPreserveSourceDestination` parameter is enabled for the network load balancer resource, this parameter cannot be disabled.
// The value is true by default.
IsPreserveSource *bool `mandatory:"false" json:"isPreserveSource"`
// If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy.
// The value is false by default.
IsFailOpen *bool `mandatory:"false" json:"isFailOpen"`
// If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
IsInstantFailoverEnabled *bool `mandatory:"false" json:"isInstantFailoverEnabled"`
// IP version associated with the backend set.
IpVersion IpVersionEnum `mandatory:"false" json:"ipVersion,omitempty"`
}
func (m BackendSetSummary) String() string
func (m BackendSetSummary) 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
BackendSummary The configuration of a backend server that is a member of a network load balancer backend set. For more information, see Managing Backend Servers (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/BackendServers/backend-server-management.htm).
type BackendSummary struct {
// The communication port for the backend server.
// Example: `8080`
Port *int `mandatory:"true" json:"port"`
// A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set.
// Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<var><unique_ID></var>:443` or `10.0.0.3:0`
Name *string `mandatory:"false" json:"name"`
// The IP address of the backend server.
// Example: `10.0.0.3`
IpAddress *string `mandatory:"false" json:"ipAddress"`
// The IP OCID/Instance OCID associated with the backend server.
// Example: `ocid1.privateip..oc1.<var><unique_ID></var>`
TargetId *string `mandatory:"false" json:"targetId"`
// The network 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 three times the number of new connections
// as a server weighted '1'.
// For more information about load balancing policies, see
// How Network Load Balancing Policies Work (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/introducton.htm#Policies).
// Example: `3`
Weight *int `mandatory:"false" json:"weight"`
// Whether the network load balancer should drain this server. Servers marked "isDrain" receive no
// incoming traffic.
// Example: `false`
IsDrain *bool `mandatory:"false" json:"isDrain"`
// Whether the network load balancer should treat this server as a backup unit. If `true`, then the network load balancer forwards no ingress
// traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy.
// Example: `false`
IsBackup *bool `mandatory:"false" json:"isBackup"`
// Whether the network load balancer should treat this server as offline. Offline servers receive no incoming
// traffic.
// Example: `false`
IsOffline *bool `mandatory:"false" json:"isOffline"`
}
func (m BackendSummary) String() string
func (m BackendSummary) 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
ChangeNetworkLoadBalancerCompartmentDetails The configuration details for moving a network load balancer to a different compartment. **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type ChangeNetworkLoadBalancerCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which to move the network load balancer.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeNetworkLoadBalancerCompartmentDetails) String() string
func (m ChangeNetworkLoadBalancerCompartmentDetails) 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
ChangeNetworkLoadBalancerCompartmentRequest wrapper for the ChangeNetworkLoadBalancerCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ChangeNetworkLoadBalancerCompartment.go.html to see an example of how to use ChangeNetworkLoadBalancerCompartmentRequest.
type ChangeNetworkLoadBalancerCompartmentRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The configuration details for moving a network load balancer to a different compartment.
ChangeNetworkLoadBalancerCompartmentDetails `contributesTo:"body"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that it can be retried in case of a timeout or
// server error without risk of rerunning that same action. Retry tokens expire after 24
// hours but they can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might 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 from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
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 ChangeNetworkLoadBalancerCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeNetworkLoadBalancerCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeNetworkLoadBalancerCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeNetworkLoadBalancerCompartmentRequest) String() string
func (request ChangeNetworkLoadBalancerCompartmentRequest) 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
ChangeNetworkLoadBalancerCompartmentResponse wrapper for the ChangeNetworkLoadBalancerCompartment operation
type ChangeNetworkLoadBalancerCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeNetworkLoadBalancerCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeNetworkLoadBalancerCompartmentResponse) String() string
CreateBackendDetails The configuration of a backend server that is a member of a network load balancer backend set. For more information, see Managing Backend Servers (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/BackendServers/backend-server-management.htm).
type CreateBackendDetails struct {
// The communication port for the backend server.
// Example: `8080`
Port *int `mandatory:"true" json:"port"`
// Optional unique name identifying the backend within the backend set. If not specified, then one will be generated.
// Example: `webServer1`
Name *string `mandatory:"false" json:"name"`
// The IP address of the backend server.
// Example: `10.0.0.3`
IpAddress *string `mandatory:"false" json:"ipAddress"`
// The IP OCID/Instance OCID associated with the backend server.
// Example: `ocid1.privateip..oc1.<var><unique_ID></var>`
TargetId *string `mandatory:"false" json:"targetId"`
// The network 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 three times the number of new connections
// as a server weighted '1'.
// For more information about load balancing policies, see
// How Network Load Balancing Policies Work (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/introducton.htm#Policies).
// Example: `3`
Weight *int `mandatory:"false" json:"weight"`
// Whether the network load balancer should drain this server. Servers marked "isDrain" receive no
// incoming traffic.
// Example: `false`
IsDrain *bool `mandatory:"false" json:"isDrain"`
// Whether the network load balancer should treat this server as a backup unit. If `true`, then the network load balancer forwards no ingress
// traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy.
// Example: `false`
IsBackup *bool `mandatory:"false" json:"isBackup"`
// Whether the network load balancer should treat this server as offline. Offline servers receive no incoming
// traffic.
// Example: `false`
IsOffline *bool `mandatory:"false" json:"isOffline"`
}
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/networkloadbalancer/CreateBackend.go.html to see an example of how to use CreateBackendRequest.
type CreateBackendRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The details to add a backend server to a backend set.
CreateBackendDetails `contributesTo:"body"`
// The name of the backend set to which to add the backend server.
// Example: `example_backend_set`
BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that it can be retried in case of a timeout or
// server error without risk of rerunning that same action. Retry tokens expire after 24
// hours but they can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might 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 from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
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 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
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
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 network load balancer. For more information about backend set configuration, see Managing Backend Sets (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/BackendSets/backend-set-management.htm). **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CreateBackendSetDetails struct {
// A user-friendly name for the backend set that must be unique and 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 network load balancer policy for the backend set.
// Example: `FIVE_TUPLE``
Policy NetworkLoadBalancingPolicyEnum `mandatory:"true" json:"policy"`
HealthChecker *HealthCheckerDetails `mandatory:"true" json:"healthChecker"`
// If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends.
// Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled.
// The value is true by default.
IsPreserveSource *bool `mandatory:"false" json:"isPreserveSource"`
// If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy.
// The value is false by default.
IsFailOpen *bool `mandatory:"false" json:"isFailOpen"`
// If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
IsInstantFailoverEnabled *bool `mandatory:"false" json:"isInstantFailoverEnabled"`
// IP version associated with the backend set.
IpVersion IpVersionEnum `mandatory:"false" json:"ipVersion,omitempty"`
// An array of backends to be associated with the backend set.
Backends []BackendDetails `mandatory:"false" json:"backends"`
}
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/networkloadbalancer/CreateBackendSet.go.html to see an example of how to use CreateBackendSetRequest.
type CreateBackendSetRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The details for adding a backend set.
CreateBackendSetDetails `contributesTo:"body"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that it can be retried in case of a timeout or
// server error without risk of rerunning that same action. Retry tokens expire after 24
// hours but they can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might 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 from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
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
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateBackendSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBackendSetResponse) String() string
CreateListenerDetails The configuration of the listener. For more information about listener configuration, see Managing Network Load Balancer Listeners (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/Listeners/listener-management.htm).
type CreateListenerDetails 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.
// For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port.
// For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true).
// "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead.
// Example: `TCP`
Protocol ListenerProtocolsEnum `mandatory:"true" json:"protocol"`
// IP version associated with the listener.
IpVersion IpVersionEnum `mandatory:"false" json:"ipVersion,omitempty"`
}
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/networkloadbalancer/CreateListener.go.html to see an example of how to use CreateListenerRequest.
type CreateListenerRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// Details to add a listener.
CreateListenerDetails `contributesTo:"body"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that it can be retried in case of a timeout or
// server error without risk of rerunning that same action. Retry tokens expire after 24
// hours but they can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might 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 from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
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
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response CreateListenerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateListenerResponse) String() string
CreateNetworkLoadBalancerDetails The properties that define a network load balancer. For more information, see Managing a network load balancer (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/NetworkLoadBalancers/network-load-balancer-management.htm). To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, then contact an administrator. If you are an administrator who writes policies to give users access, then 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 CreateNetworkLoadBalancerDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancer.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Network load balancer identifier, which can be renamed.
DisplayName *string `mandatory:"true" json:"displayName"`
// The subnet in which the network load balancer is spawned OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
SubnetId *string `mandatory:"true" json:"subnetId"`
// This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically
// enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
IsPreserveSourceDestination *bool `mandatory:"false" json:"isPreserveSourceDestination"`
// This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled.
// This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.
IsSymmetricHashEnabled *bool `mandatory:"false" json:"isSymmetricHashEnabled"`
// An array of reserved Ips.
ReservedIps []ReservedIp `mandatory:"false" json:"reservedIps"`
// Whether the network load balancer has a virtual cloud network-local (private) IP address.
// If "true", then the service assigns a private IP address to the network load balancer.
// If "false", then the service assigns a public IP address to the network load balancer.
// A public network load balancer is accessible from the internet, depending on the
// security list rules (https://docs.cloud.oracle.com/Content/network/Concepts/securitylists.htm) for your virtual cloud network. For more information about public and
// private network load balancers,
// see How Network Load Balancing Works (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/overview.htm).
// This value is true by default.
// Example: `true`
IsPrivate *bool `mandatory:"false" json:"isPrivate"`
// An array of network security groups OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with the network load
// balancer.
// During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.
// The benefits of associating the network load balancer with network security groups include:
// * Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
// * The network security rules of other resources can reference the network security groups associated with the network load balancer
// to ensure access.
// Example: ["ocid1.nsg.oc1.phx.unique_ID"]
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
// IP version associated with the NLB.
NlbIpVersion NlbIpVersionEnum `mandatory:"false" json:"nlbIpVersion,omitempty"`
// IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.
SubnetIpv6Cidr *string `mandatory:"false" json:"subnetIpv6Cidr"`
// Private IP address to be assigned to the network load balancer being created.
// This IP address has to be in the CIDR range of the subnet where network load balancer is being created
// Example: "10.0.0.1"
AssignedPrivateIpv4 *string `mandatory:"false" json:"assignedPrivateIpv4"`
// IPv6 address to be assigned to the network load balancer being created.
// This IP address has to be part of one of the prefixes supported by the subnet.
// Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
AssignedIpv6 *string `mandatory:"false" json:"assignedIpv6"`
// Listeners associated with the network load balancer.
Listeners map[string]ListenerDetails `mandatory:"false" json:"listeners"`
// Backend sets associated with the network load balancer.
BackendSets map[string]BackendSetDetails `mandatory:"false" json:"backendSets"`
// Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateNetworkLoadBalancerDetails) String() string
func (m CreateNetworkLoadBalancerDetails) 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
CreateNetworkLoadBalancerRequest wrapper for the CreateNetworkLoadBalancer operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/CreateNetworkLoadBalancer.go.html to see an example of how to use CreateNetworkLoadBalancerRequest.
type CreateNetworkLoadBalancerRequest struct {
// Details for the new network load balancer.
CreateNetworkLoadBalancerDetails `contributesTo:"body"`
// A token that uniquely identifies a request so that it can be retried in case of a timeout or
// server error without risk of rerunning that same action. Retry tokens expire after 24
// hours but they can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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 CreateNetworkLoadBalancerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateNetworkLoadBalancerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateNetworkLoadBalancerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateNetworkLoadBalancerRequest) String() string
func (request CreateNetworkLoadBalancerRequest) 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
CreateNetworkLoadBalancerResponse wrapper for the CreateNetworkLoadBalancer operation
type CreateNetworkLoadBalancerResponse struct {
// The underlying http response
RawResponse *http.Response
// The NetworkLoadBalancer instance
NetworkLoadBalancer `presentIn:"body"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateNetworkLoadBalancerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateNetworkLoadBalancerResponse) String() string
DeleteBackendRequest wrapper for the DeleteBackend operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/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 network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The name of the backend set associated with the backend server.
// Example: `example_backend_set`
BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`
// The name of the backend server to remove.
// If the backend was created with an explicitly specified name, that name should be used here.
// If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>.
// If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>.
// Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var><unique_ID></var>:8080`
BackendName *string `mandatory:"true" contributesTo:"path" name:"backendName"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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 from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
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
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
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/networkloadbalancer/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 network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// 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 must contact Oracle about a
// particular request, then provide the request identifier.
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 from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
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
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteBackendSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBackendSetResponse) 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/networkloadbalancer/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 network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// 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 must contact Oracle about a
// particular request, then provide the request identifier.
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 from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
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
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
ETag *string `presentIn:"header" name:"etag"`
}
func (response DeleteListenerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteListenerResponse) String() string
DeleteNetworkLoadBalancerRequest wrapper for the DeleteNetworkLoadBalancer operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/DeleteNetworkLoadBalancer.go.html to see an example of how to use DeleteNetworkLoadBalancerRequest.
type DeleteNetworkLoadBalancerRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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 DeleteNetworkLoadBalancerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteNetworkLoadBalancerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteNetworkLoadBalancerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteNetworkLoadBalancerRequest) String() string
func (request DeleteNetworkLoadBalancerRequest) 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
DeleteNetworkLoadBalancerResponse wrapper for the DeleteNetworkLoadBalancer operation
type DeleteNetworkLoadBalancerResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteNetworkLoadBalancerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteNetworkLoadBalancerResponse) String() string
DnsHealthCheckQueryClassesEnum Enum with underlying type: string
type DnsHealthCheckQueryClassesEnum string
Set of constants representing the allowable values for DnsHealthCheckQueryClassesEnum
const (
DnsHealthCheckQueryClassesIn DnsHealthCheckQueryClassesEnum = "IN"
DnsHealthCheckQueryClassesCh DnsHealthCheckQueryClassesEnum = "CH"
)
func GetDnsHealthCheckQueryClassesEnumValues() []DnsHealthCheckQueryClassesEnum
GetDnsHealthCheckQueryClassesEnumValues Enumerates the set of values for DnsHealthCheckQueryClassesEnum
func GetMappingDnsHealthCheckQueryClassesEnum(val string) (DnsHealthCheckQueryClassesEnum, bool)
GetMappingDnsHealthCheckQueryClassesEnum performs case Insensitive comparison on enum value and return the desired enum
DnsHealthCheckQueryTypesEnum Enum with underlying type: string
type DnsHealthCheckQueryTypesEnum string
Set of constants representing the allowable values for DnsHealthCheckQueryTypesEnum
const (
DnsHealthCheckQueryTypesA DnsHealthCheckQueryTypesEnum = "A"
DnsHealthCheckQueryTypesTxt DnsHealthCheckQueryTypesEnum = "TXT"
DnsHealthCheckQueryTypesAaaa DnsHealthCheckQueryTypesEnum = "AAAA"
)
func GetDnsHealthCheckQueryTypesEnumValues() []DnsHealthCheckQueryTypesEnum
GetDnsHealthCheckQueryTypesEnumValues Enumerates the set of values for DnsHealthCheckQueryTypesEnum
func GetMappingDnsHealthCheckQueryTypesEnum(val string) (DnsHealthCheckQueryTypesEnum, bool)
GetMappingDnsHealthCheckQueryTypesEnum performs case Insensitive comparison on enum value and return the desired enum
DnsHealthCheckRCodesEnum Enum with underlying type: string
type DnsHealthCheckRCodesEnum string
Set of constants representing the allowable values for DnsHealthCheckRCodesEnum
const (
DnsHealthCheckRCodesNoerror DnsHealthCheckRCodesEnum = "NOERROR"
DnsHealthCheckRCodesServfail DnsHealthCheckRCodesEnum = "SERVFAIL"
DnsHealthCheckRCodesNxdomain DnsHealthCheckRCodesEnum = "NXDOMAIN"
DnsHealthCheckRCodesRefused DnsHealthCheckRCodesEnum = "REFUSED"
)
func GetDnsHealthCheckRCodesEnumValues() []DnsHealthCheckRCodesEnum
GetDnsHealthCheckRCodesEnumValues Enumerates the set of values for DnsHealthCheckRCodesEnum
func GetMappingDnsHealthCheckRCodesEnum(val string) (DnsHealthCheckRCodesEnum, bool)
GetMappingDnsHealthCheckRCodesEnum performs case Insensitive comparison on enum value and return the desired enum
DnsHealthCheckTransportProtocolsEnum Enum with underlying type: string
type DnsHealthCheckTransportProtocolsEnum string
Set of constants representing the allowable values for DnsHealthCheckTransportProtocolsEnum
const (
DnsHealthCheckTransportProtocolsUdp DnsHealthCheckTransportProtocolsEnum = "UDP"
DnsHealthCheckTransportProtocolsTcp DnsHealthCheckTransportProtocolsEnum = "TCP"
)
func GetDnsHealthCheckTransportProtocolsEnumValues() []DnsHealthCheckTransportProtocolsEnum
GetDnsHealthCheckTransportProtocolsEnumValues Enumerates the set of values for DnsHealthCheckTransportProtocolsEnum
func GetMappingDnsHealthCheckTransportProtocolsEnum(val string) (DnsHealthCheckTransportProtocolsEnum, bool)
GetMappingDnsHealthCheckTransportProtocolsEnum performs case Insensitive comparison on enum value and return the desired enum
DnsHealthCheckerDetails DNS healthcheck configurations.
type DnsHealthCheckerDetails struct {
// The absolute fully-qualified domain name to perform periodic DNS queries.
// If not provided, an extra dot will be added at the end of a domain name during the query.
DomainName *string `mandatory:"true" json:"domainName"`
// DNS transport protocol; either UDP or TCP.
// Example: `UDP`
TransportProtocol DnsHealthCheckTransportProtocolsEnum `mandatory:"false" json:"transportProtocol,omitempty"`
// The class the dns health check query to use; either IN or CH.
// Example: `IN`
QueryClass DnsHealthCheckQueryClassesEnum `mandatory:"false" json:"queryClass,omitempty"`
// The type the dns health check query to use; A, AAAA, TXT.
// Example: `A`
QueryType DnsHealthCheckQueryTypesEnum `mandatory:"false" json:"queryType,omitempty"`
// An array that represents accepetable RCODE values for DNS query response.
// Example: ["NOERROR", "NXDOMAIN"]
Rcodes []DnsHealthCheckRCodesEnum `mandatory:"false" json:"rcodes"`
}
func (m DnsHealthCheckerDetails) String() string
func (m DnsHealthCheckerDetails) 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/networkloadbalancer/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 network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The name of the backend set associated with the backend server for which to retrieve the health status.
// Example: `example_backend_set`
BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`
// The name of the backend server to retrieve health status for.
// If the backend was created with an explicitly specified name, that name should be used here.
// If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>.
// If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>.
// Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var><unique_ID></var>:8080`
BackendName *string `mandatory:"true" contributesTo:"path" name:"backendName"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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 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 must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
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/networkloadbalancer/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 network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The name of the backend set that includes the backend server.
// Example: `example_backend_set`
BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`
// The name of the backend server to retrieve.
// If the backend was created with an explicitly specified name, that name should be used here.
// If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>.
// If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>.
// Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var><unique_ID></var>:8080`
BackendName *string `mandatory:"true" contributesTo:"path" name:"backendName"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The system returns the requested resource, with a 200 status, only if the resource has no etag
// matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the
// HTTP status code `304 (Not Modified)`.
// Example: `example-etag`
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-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 must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// 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/networkloadbalancer/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 network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The name of the backend set for which to retrieve the health status.
// Example: `example_backend_set`
BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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 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 must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// 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/networkloadbalancer/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 network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// 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 must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The system returns the requested resource, with a 200 status, only if the resource has no etag
// matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the
// HTTP status code `304 (Not Modified)`.
// Example: `example-etag`
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-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 must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// 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/networkloadbalancer/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 network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// 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 must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that it can be retried in case of a timeout or
// server error without risk of rerunning that same action. Retry tokens expire after 24
// hours but they can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The system returns the requested resource, with a 200 status, only if the resource has no etag
// matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the
// HTTP status code `304 (Not Modified)`.
// Example: `example-etag`
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-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 must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// 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
GetListenerRequest wrapper for the GetListener operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/GetListener.go.html to see an example of how to use GetListenerRequest.
type GetListenerRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The name of the listener to get.
// Example: `example_listener`
ListenerName *string `mandatory:"true" contributesTo:"path" name:"listenerName"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The system returns the requested resource, with a 200 status, only if the resource has no etag
// matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the
// HTTP status code `304 (Not Modified)`.
// Example: `example-etag`
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-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 GetListenerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetListenerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetListenerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetListenerRequest) String() string
func (request GetListenerRequest) 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
GetListenerResponse wrapper for the GetListener operation
type GetListenerResponse struct {
// The underlying http response
RawResponse *http.Response
// The Listener instance
Listener `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetListenerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetListenerResponse) String() string
GetNetworkLoadBalancerHealthRequest wrapper for the GetNetworkLoadBalancerHealth operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/GetNetworkLoadBalancerHealth.go.html to see an example of how to use GetNetworkLoadBalancerHealthRequest.
type GetNetworkLoadBalancerHealthRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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 GetNetworkLoadBalancerHealthRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetNetworkLoadBalancerHealthRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetNetworkLoadBalancerHealthRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetNetworkLoadBalancerHealthRequest) String() string
func (request GetNetworkLoadBalancerHealthRequest) 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
GetNetworkLoadBalancerHealthResponse wrapper for the GetNetworkLoadBalancerHealth operation
type GetNetworkLoadBalancerHealthResponse struct {
// The underlying http response
RawResponse *http.Response
// The NetworkLoadBalancerHealth instance
NetworkLoadBalancerHealth `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetNetworkLoadBalancerHealthResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetNetworkLoadBalancerHealthResponse) String() string
GetNetworkLoadBalancerRequest wrapper for the GetNetworkLoadBalancer operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/GetNetworkLoadBalancer.go.html to see an example of how to use GetNetworkLoadBalancerRequest.
type GetNetworkLoadBalancerRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The system returns the requested resource, with a 200 status, only if the resource has no etag
// matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the
// HTTP status code `304 (Not Modified)`.
// Example: `example-etag`
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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 GetNetworkLoadBalancerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetNetworkLoadBalancerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetNetworkLoadBalancerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetNetworkLoadBalancerRequest) String() string
func (request GetNetworkLoadBalancerRequest) 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
GetNetworkLoadBalancerResponse wrapper for the GetNetworkLoadBalancer operation
type GetNetworkLoadBalancerResponse struct {
// The underlying http response
RawResponse *http.Response
// The NetworkLoadBalancer instance
NetworkLoadBalancer `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetNetworkLoadBalancerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetNetworkLoadBalancerResponse) 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/networkloadbalancer/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The identifier of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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 must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HcsInfraIpVersionEnum Enum with underlying type: string
type HcsInfraIpVersionEnum string
Set of constants representing the allowable values for HcsInfraIpVersionEnum
const (
HcsInfraIpVersionIpv4 HcsInfraIpVersionEnum = "IPV4"
HcsInfraIpVersionIpv4AndIpv6 HcsInfraIpVersionEnum = "IPV4_AND_IPV6"
HcsInfraIpVersionIpv6 HcsInfraIpVersionEnum = "IPV6"
)
func GetHcsInfraIpVersionEnumValues() []HcsInfraIpVersionEnum
GetHcsInfraIpVersionEnumValues Enumerates the set of values for HcsInfraIpVersionEnum
func GetMappingHcsInfraIpVersionEnum(val string) (HcsInfraIpVersionEnum, bool)
GetMappingHcsInfraIpVersionEnum performs case Insensitive comparison on enum value and return the desired enum
HealthCheckProtocolsEnum Enum with underlying type: string
type HealthCheckProtocolsEnum string
Set of constants representing the allowable values for HealthCheckProtocolsEnum
const (
HealthCheckProtocolsHttp HealthCheckProtocolsEnum = "HTTP"
HealthCheckProtocolsHttps HealthCheckProtocolsEnum = "HTTPS"
HealthCheckProtocolsTcp HealthCheckProtocolsEnum = "TCP"
HealthCheckProtocolsUdp HealthCheckProtocolsEnum = "UDP"
HealthCheckProtocolsDns HealthCheckProtocolsEnum = "DNS"
)
func GetHealthCheckProtocolsEnumValues() []HealthCheckProtocolsEnum
GetHealthCheckProtocolsEnumValues Enumerates the set of values for HealthCheckProtocolsEnum
func GetMappingHealthCheckProtocolsEnum(val string) (HealthCheckProtocolsEnum, bool)
GetMappingHealthCheckProtocolsEnum performs case Insensitive comparison on enum value and return the desired enum
HealthCheckResult Information about a single backend server health check result reported by a network load balancer.
type HealthCheckResult struct {
// The date and time the data was retrieved, in the format defined by RFC3339.
// Example: `2020-05-01T18: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"
HealthCheckResultHealthCheckStatusHealthPayloadMismatch HealthCheckResultHealthCheckStatusEnum = "HEALTH_PAYLOAD_MISMATCH"
HealthCheckResultHealthCheckStatusConnectFailed HealthCheckResultHealthCheckStatusEnum = "CONNECT_FAILED"
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/NetworkLoadBalancer/HealthCheckPolicies/health-check-policy-management.htm).
type HealthChecker struct {
// The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP.
// Example: `HTTP`
Protocol HealthCheckProtocolsEnum `mandatory:"true" json:"protocol"`
// The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the
// port information from the `Backend` object. The port must be specified if the backend port is 0.
// Example: `8080`
Port *int `mandatory:"false" json:"port"`
// 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. The default value is 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. The default value is 3000 (3 seconds).
// Example: `3000`
TimeoutInMillis *int `mandatory:"false" json:"timeoutInMillis"`
// The interval between health checks, in milliseconds. The default value is 10000 (10 seconds).
// Example: `10000`
IntervalInMillis *int `mandatory:"false" json:"intervalInMillis"`
// The path against which to run the health check.
// Example: `/healthcheck`
UrlPath *string `mandatory:"false" json:"urlPath"`
// A regular expression for parsing the response body from the backend server.
// Example: `^((?!false).|\s)*$`
ResponseBodyRegex *string `mandatory:"false" json:"responseBodyRegex"`
// The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol,
// then you can use common HTTP status codes such as "200".
// Example: `200`
ReturnCode *int `mandatory:"false" json:"returnCode"`
// Base64 encoded pattern to be sent as UDP or TCP health check probe.
RequestData []byte `mandatory:"false" json:"requestData"`
// Base64 encoded pattern to be validated as UDP or TCP health check probe response.
ResponseData []byte `mandatory:"false" json:"responseData"`
Dns *DnsHealthCheckerDetails `mandatory:"false" json:"dns"`
}
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 configuration. For more information, see Editing Health Check Policies (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/HealthCheckPolicies/health-check-policy-management.htm).
type HealthCheckerDetails struct {
// The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP.
// Example: `HTTP`
Protocol HealthCheckProtocolsEnum `mandatory:"true" json:"protocol"`
// The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the
// port information from the `Backend` object. The port must be specified if the backend port is 0.
// Example: `8080`
Port *int `mandatory:"false" json:"port"`
// 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. The default value is 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. The default value is 3000 (3 seconds).
// Example: `3000`
TimeoutInMillis *int `mandatory:"false" json:"timeoutInMillis"`
// The interval between health checks, in milliseconds. The default value is 10000 (10 seconds).
// Example: `10000`
IntervalInMillis *int `mandatory:"false" json:"intervalInMillis"`
// The path against which to run the health check.
// Example: `/healthcheck`
UrlPath *string `mandatory:"false" json:"urlPath"`
// A regular expression for parsing the response body from the backend server.
// Example: `^((?!false).|\s)*$`
ResponseBodyRegex *string `mandatory:"false" json:"responseBodyRegex"`
// The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol,
// then you can use common HTTP status codes such as "200".
// Example: `200`
ReturnCode *int `mandatory:"false" json:"returnCode"`
// Base64 encoded pattern to be sent as UDP or TCP health check probe.
RequestData []byte `mandatory:"false" json:"requestData"`
// Base64 encoded pattern to be validated as UDP or TCP health check probe response.
ResponseData []byte `mandatory:"false" json:"responseData"`
Dns *DnsHealthCheckerDetails `mandatory:"false" json:"dns"`
}
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
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", then the IP address is public and accessible from the internet.
// If "false", then the IP address is private and accessible only from within the associated virtual cloud network.
IsPublic *bool `mandatory:"false" json:"isPublic"`
// IP version associated with this IP address.
IpVersion IpVersionEnum `mandatory:"false" json:"ipVersion,omitempty"`
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
IpVersionEnum Enum with underlying type: string
type IpVersionEnum string
Set of constants representing the allowable values for IpVersionEnum
const (
IpVersionIpv4 IpVersionEnum = "IPV4"
IpVersionIpv6 IpVersionEnum = "IPV6"
)
func GetIpVersionEnumValues() []IpVersionEnum
GetIpVersionEnumValues Enumerates the set of values for IpVersionEnum
func GetMappingIpVersionEnum(val string) (IpVersionEnum, bool)
GetMappingIpVersionEnum performs case Insensitive comparison on enum value and return the desired enum
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum
const (
LifecycleStateCreating LifecycleStateEnum = "CREATING"
LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateDeleting LifecycleStateEnum = "DELETING"
LifecycleStateDeleted LifecycleStateEnum = "DELETED"
LifecycleStateFailed LifecycleStateEnum = "FAILED"
)
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListBackendSetsRequest wrapper for the ListBackendSets operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/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 network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The system returns the requested resource, with a 200 status, only if the resource has no etag
// matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the
// HTTP status code `304 (Not Modified)`.
// Example: `example-etag`
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// 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).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page from which to start retrieving results.
// 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).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' (ascending) or 'desc' (descending).
SortOrder ListBackendSetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.
// The default order for displayName is ascending. If no value is specified, then timeCreated is the default.
SortBy ListBackendSetsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" 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 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
// A list of BackendSetCollection instances
BackendSetCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListBackendSetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBackendSetsResponse) String() string
ListBackendSetsSortByEnum Enum with underlying type: string
type ListBackendSetsSortByEnum string
Set of constants representing the allowable values for ListBackendSetsSortByEnum
const (
ListBackendSetsSortByTimecreated ListBackendSetsSortByEnum = "timeCreated"
ListBackendSetsSortByDisplayname ListBackendSetsSortByEnum = "displayName"
)
func GetListBackendSetsSortByEnumValues() []ListBackendSetsSortByEnum
GetListBackendSetsSortByEnumValues Enumerates the set of values for ListBackendSetsSortByEnum
func GetMappingListBackendSetsSortByEnum(val string) (ListBackendSetsSortByEnum, bool)
GetMappingListBackendSetsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBackendSetsSortOrderEnum Enum with underlying type: string
type ListBackendSetsSortOrderEnum string
Set of constants representing the allowable values for ListBackendSetsSortOrderEnum
const (
ListBackendSetsSortOrderAsc ListBackendSetsSortOrderEnum = "ASC"
ListBackendSetsSortOrderDesc ListBackendSetsSortOrderEnum = "DESC"
)
func GetListBackendSetsSortOrderEnumValues() []ListBackendSetsSortOrderEnum
GetListBackendSetsSortOrderEnumValues Enumerates the set of values for ListBackendSetsSortOrderEnum
func GetMappingListBackendSetsSortOrderEnum(val string) (ListBackendSetsSortOrderEnum, bool)
GetMappingListBackendSetsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListBackendsRequest wrapper for the ListBackends operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/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 network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// 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 must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The system returns the requested resource, with a 200 status, only if the resource has no etag
// matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the
// HTTP status code `304 (Not Modified)`.
// Example: `example-etag`
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// 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).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page from which to start retrieving results.
// 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).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' (ascending) or 'desc' (descending).
SortOrder ListBackendsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.
// The default order for displayName is ascending. If no value is specified, then timeCreated is the default.
SortBy ListBackendsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" 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 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
// A list of BackendCollection instances
BackendCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListBackendsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBackendsResponse) String() string
ListBackendsSortByEnum Enum with underlying type: string
type ListBackendsSortByEnum string
Set of constants representing the allowable values for ListBackendsSortByEnum
const (
ListBackendsSortByTimecreated ListBackendsSortByEnum = "timeCreated"
ListBackendsSortByDisplayname ListBackendsSortByEnum = "displayName"
)
func GetListBackendsSortByEnumValues() []ListBackendsSortByEnum
GetListBackendsSortByEnumValues Enumerates the set of values for ListBackendsSortByEnum
func GetMappingListBackendsSortByEnum(val string) (ListBackendsSortByEnum, bool)
GetMappingListBackendsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBackendsSortOrderEnum Enum with underlying type: string
type ListBackendsSortOrderEnum string
Set of constants representing the allowable values for ListBackendsSortOrderEnum
const (
ListBackendsSortOrderAsc ListBackendsSortOrderEnum = "ASC"
ListBackendsSortOrderDesc ListBackendsSortOrderEnum = "DESC"
)
func GetListBackendsSortOrderEnumValues() []ListBackendsSortOrderEnum
GetListBackendsSortOrderEnumValues Enumerates the set of values for ListBackendsSortOrderEnum
func GetMappingListBackendsSortOrderEnum(val string) (ListBackendsSortOrderEnum, bool)
GetMappingListBackendsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListListenersRequest wrapper for the ListListeners operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListListeners.go.html to see an example of how to use ListListenersRequest.
type ListListenersRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The system returns the requested resource, with a 200 status, only if the resource has no etag
// matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the
// HTTP status code `304 (Not Modified)`.
// Example: `example-etag`
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// 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).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page from which to start retrieving results.
// 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).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' (ascending) or 'desc' (descending).
SortOrder ListListenersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.
// The default order for displayName is ascending. If no value is specified, then timeCreated is the default.
SortBy ListListenersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" 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 ListListenersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListListenersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListListenersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListListenersRequest) String() string
func (request ListListenersRequest) 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
ListListenersResponse wrapper for the ListListeners operation
type ListListenersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ListenerCollection instances
ListenerCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListListenersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListListenersResponse) String() string
ListListenersSortByEnum Enum with underlying type: string
type ListListenersSortByEnum string
Set of constants representing the allowable values for ListListenersSortByEnum
const (
ListListenersSortByTimecreated ListListenersSortByEnum = "timeCreated"
ListListenersSortByDisplayname ListListenersSortByEnum = "displayName"
)
func GetListListenersSortByEnumValues() []ListListenersSortByEnum
GetListListenersSortByEnumValues Enumerates the set of values for ListListenersSortByEnum
func GetMappingListListenersSortByEnum(val string) (ListListenersSortByEnum, bool)
GetMappingListListenersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListListenersSortOrderEnum Enum with underlying type: string
type ListListenersSortOrderEnum string
Set of constants representing the allowable values for ListListenersSortOrderEnum
const (
ListListenersSortOrderAsc ListListenersSortOrderEnum = "ASC"
ListListenersSortOrderDesc ListListenersSortOrderEnum = "DESC"
)
func GetListListenersSortOrderEnumValues() []ListListenersSortOrderEnum
GetListListenersSortOrderEnumValues Enumerates the set of values for ListListenersSortOrderEnum
func GetMappingListListenersSortOrderEnum(val string) (ListListenersSortOrderEnum, bool)
GetMappingListListenersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListNetworkLoadBalancerHealthsRequest wrapper for the ListNetworkLoadBalancerHealths operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListNetworkLoadBalancerHealths.go.html to see an example of how to use ListNetworkLoadBalancerHealthsRequest.
type ListNetworkLoadBalancerHealthsRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The sort order to use, either 'asc' (ascending) or 'desc' (descending).
SortOrder ListNetworkLoadBalancerHealthsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.
// The default order for displayName is ascending. If no value is specified, then timeCreated is the default.
SortBy ListNetworkLoadBalancerHealthsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page from which to start retrieving results.
// 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).
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 ListNetworkLoadBalancerHealthsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListNetworkLoadBalancerHealthsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListNetworkLoadBalancerHealthsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListNetworkLoadBalancerHealthsRequest) String() string
func (request ListNetworkLoadBalancerHealthsRequest) 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
ListNetworkLoadBalancerHealthsResponse wrapper for the ListNetworkLoadBalancerHealths operation
type ListNetworkLoadBalancerHealthsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of NetworkLoadBalancerHealthCollection instances
NetworkLoadBalancerHealthCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListNetworkLoadBalancerHealthsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListNetworkLoadBalancerHealthsResponse) String() string
ListNetworkLoadBalancerHealthsSortByEnum Enum with underlying type: string
type ListNetworkLoadBalancerHealthsSortByEnum string
Set of constants representing the allowable values for ListNetworkLoadBalancerHealthsSortByEnum
const (
ListNetworkLoadBalancerHealthsSortByTimecreated ListNetworkLoadBalancerHealthsSortByEnum = "timeCreated"
ListNetworkLoadBalancerHealthsSortByDisplayname ListNetworkLoadBalancerHealthsSortByEnum = "displayName"
)
func GetListNetworkLoadBalancerHealthsSortByEnumValues() []ListNetworkLoadBalancerHealthsSortByEnum
GetListNetworkLoadBalancerHealthsSortByEnumValues Enumerates the set of values for ListNetworkLoadBalancerHealthsSortByEnum
func GetMappingListNetworkLoadBalancerHealthsSortByEnum(val string) (ListNetworkLoadBalancerHealthsSortByEnum, bool)
GetMappingListNetworkLoadBalancerHealthsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListNetworkLoadBalancerHealthsSortOrderEnum Enum with underlying type: string
type ListNetworkLoadBalancerHealthsSortOrderEnum string
Set of constants representing the allowable values for ListNetworkLoadBalancerHealthsSortOrderEnum
const (
ListNetworkLoadBalancerHealthsSortOrderAsc ListNetworkLoadBalancerHealthsSortOrderEnum = "ASC"
ListNetworkLoadBalancerHealthsSortOrderDesc ListNetworkLoadBalancerHealthsSortOrderEnum = "DESC"
)
func GetListNetworkLoadBalancerHealthsSortOrderEnumValues() []ListNetworkLoadBalancerHealthsSortOrderEnum
GetListNetworkLoadBalancerHealthsSortOrderEnumValues Enumerates the set of values for ListNetworkLoadBalancerHealthsSortOrderEnum
func GetMappingListNetworkLoadBalancerHealthsSortOrderEnum(val string) (ListNetworkLoadBalancerHealthsSortOrderEnum, bool)
GetMappingListNetworkLoadBalancerHealthsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListNetworkLoadBalancersLifecycleStateEnum Enum with underlying type: string
type ListNetworkLoadBalancersLifecycleStateEnum string
Set of constants representing the allowable values for ListNetworkLoadBalancersLifecycleStateEnum
const (
ListNetworkLoadBalancersLifecycleStateCreating ListNetworkLoadBalancersLifecycleStateEnum = "CREATING"
ListNetworkLoadBalancersLifecycleStateUpdating ListNetworkLoadBalancersLifecycleStateEnum = "UPDATING"
ListNetworkLoadBalancersLifecycleStateActive ListNetworkLoadBalancersLifecycleStateEnum = "ACTIVE"
ListNetworkLoadBalancersLifecycleStateDeleting ListNetworkLoadBalancersLifecycleStateEnum = "DELETING"
ListNetworkLoadBalancersLifecycleStateDeleted ListNetworkLoadBalancersLifecycleStateEnum = "DELETED"
ListNetworkLoadBalancersLifecycleStateFailed ListNetworkLoadBalancersLifecycleStateEnum = "FAILED"
)
func GetListNetworkLoadBalancersLifecycleStateEnumValues() []ListNetworkLoadBalancersLifecycleStateEnum
GetListNetworkLoadBalancersLifecycleStateEnumValues Enumerates the set of values for ListNetworkLoadBalancersLifecycleStateEnum
func GetMappingListNetworkLoadBalancersLifecycleStateEnum(val string) (ListNetworkLoadBalancersLifecycleStateEnum, bool)
GetMappingListNetworkLoadBalancersLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListNetworkLoadBalancersPoliciesRequest wrapper for the ListNetworkLoadBalancersPolicies operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListNetworkLoadBalancersPolicies.go.html to see an example of how to use ListNetworkLoadBalancersPoliciesRequest.
type ListNetworkLoadBalancersPoliciesRequest struct {
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page from which to start retrieving results.
// 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).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' (ascending) or 'desc' (descending).
SortOrder ListNetworkLoadBalancersPoliciesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.
// The default order for displayName is ascending. If no value is specified, then timeCreated is the default.
SortBy ListNetworkLoadBalancersPoliciesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" 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 ListNetworkLoadBalancersPoliciesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListNetworkLoadBalancersPoliciesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListNetworkLoadBalancersPoliciesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListNetworkLoadBalancersPoliciesRequest) String() string
func (request ListNetworkLoadBalancersPoliciesRequest) 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
ListNetworkLoadBalancersPoliciesResponse wrapper for the ListNetworkLoadBalancersPolicies operation
type ListNetworkLoadBalancersPoliciesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of NetworkLoadBalancersPolicyCollection instances
NetworkLoadBalancersPolicyCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListNetworkLoadBalancersPoliciesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListNetworkLoadBalancersPoliciesResponse) String() string
ListNetworkLoadBalancersPoliciesSortByEnum Enum with underlying type: string
type ListNetworkLoadBalancersPoliciesSortByEnum string
Set of constants representing the allowable values for ListNetworkLoadBalancersPoliciesSortByEnum
const (
ListNetworkLoadBalancersPoliciesSortByTimecreated ListNetworkLoadBalancersPoliciesSortByEnum = "timeCreated"
ListNetworkLoadBalancersPoliciesSortByDisplayname ListNetworkLoadBalancersPoliciesSortByEnum = "displayName"
)
func GetListNetworkLoadBalancersPoliciesSortByEnumValues() []ListNetworkLoadBalancersPoliciesSortByEnum
GetListNetworkLoadBalancersPoliciesSortByEnumValues Enumerates the set of values for ListNetworkLoadBalancersPoliciesSortByEnum
func GetMappingListNetworkLoadBalancersPoliciesSortByEnum(val string) (ListNetworkLoadBalancersPoliciesSortByEnum, bool)
GetMappingListNetworkLoadBalancersPoliciesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListNetworkLoadBalancersPoliciesSortOrderEnum Enum with underlying type: string
type ListNetworkLoadBalancersPoliciesSortOrderEnum string
Set of constants representing the allowable values for ListNetworkLoadBalancersPoliciesSortOrderEnum
const (
ListNetworkLoadBalancersPoliciesSortOrderAsc ListNetworkLoadBalancersPoliciesSortOrderEnum = "ASC"
ListNetworkLoadBalancersPoliciesSortOrderDesc ListNetworkLoadBalancersPoliciesSortOrderEnum = "DESC"
)
func GetListNetworkLoadBalancersPoliciesSortOrderEnumValues() []ListNetworkLoadBalancersPoliciesSortOrderEnum
GetListNetworkLoadBalancersPoliciesSortOrderEnumValues Enumerates the set of values for ListNetworkLoadBalancersPoliciesSortOrderEnum
func GetMappingListNetworkLoadBalancersPoliciesSortOrderEnum(val string) (ListNetworkLoadBalancersPoliciesSortOrderEnum, bool)
GetMappingListNetworkLoadBalancersPoliciesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListNetworkLoadBalancersProtocolsRequest wrapper for the ListNetworkLoadBalancersProtocols operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListNetworkLoadBalancersProtocols.go.html to see an example of how to use ListNetworkLoadBalancersProtocolsRequest.
type ListNetworkLoadBalancersProtocolsRequest struct {
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page from which to start retrieving results.
// 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).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' (ascending) or 'desc' (descending).
SortOrder ListNetworkLoadBalancersProtocolsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.
// The default order for displayName is ascending. If no value is specified, then timeCreated is the default.
SortBy ListNetworkLoadBalancersProtocolsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" 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 ListNetworkLoadBalancersProtocolsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListNetworkLoadBalancersProtocolsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListNetworkLoadBalancersProtocolsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListNetworkLoadBalancersProtocolsRequest) String() string
func (request ListNetworkLoadBalancersProtocolsRequest) 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
ListNetworkLoadBalancersProtocolsResponse wrapper for the ListNetworkLoadBalancersProtocols operation
type ListNetworkLoadBalancersProtocolsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of NetworkLoadBalancersProtocolCollection instances
NetworkLoadBalancersProtocolCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListNetworkLoadBalancersProtocolsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListNetworkLoadBalancersProtocolsResponse) String() string
ListNetworkLoadBalancersProtocolsSortByEnum Enum with underlying type: string
type ListNetworkLoadBalancersProtocolsSortByEnum string
Set of constants representing the allowable values for ListNetworkLoadBalancersProtocolsSortByEnum
const (
ListNetworkLoadBalancersProtocolsSortByTimecreated ListNetworkLoadBalancersProtocolsSortByEnum = "timeCreated"
ListNetworkLoadBalancersProtocolsSortByDisplayname ListNetworkLoadBalancersProtocolsSortByEnum = "displayName"
)
func GetListNetworkLoadBalancersProtocolsSortByEnumValues() []ListNetworkLoadBalancersProtocolsSortByEnum
GetListNetworkLoadBalancersProtocolsSortByEnumValues Enumerates the set of values for ListNetworkLoadBalancersProtocolsSortByEnum
func GetMappingListNetworkLoadBalancersProtocolsSortByEnum(val string) (ListNetworkLoadBalancersProtocolsSortByEnum, bool)
GetMappingListNetworkLoadBalancersProtocolsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListNetworkLoadBalancersProtocolsSortOrderEnum Enum with underlying type: string
type ListNetworkLoadBalancersProtocolsSortOrderEnum string
Set of constants representing the allowable values for ListNetworkLoadBalancersProtocolsSortOrderEnum
const (
ListNetworkLoadBalancersProtocolsSortOrderAsc ListNetworkLoadBalancersProtocolsSortOrderEnum = "ASC"
ListNetworkLoadBalancersProtocolsSortOrderDesc ListNetworkLoadBalancersProtocolsSortOrderEnum = "DESC"
)
func GetListNetworkLoadBalancersProtocolsSortOrderEnumValues() []ListNetworkLoadBalancersProtocolsSortOrderEnum
GetListNetworkLoadBalancersProtocolsSortOrderEnumValues Enumerates the set of values for ListNetworkLoadBalancersProtocolsSortOrderEnum
func GetMappingListNetworkLoadBalancersProtocolsSortOrderEnum(val string) (ListNetworkLoadBalancersProtocolsSortOrderEnum, bool)
GetMappingListNetworkLoadBalancersProtocolsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListNetworkLoadBalancersRequest wrapper for the ListNetworkLoadBalancers operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListNetworkLoadBalancers.go.html to see an example of how to use ListNetworkLoadBalancersRequest.
type ListNetworkLoadBalancersRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the given lifecycle state.
LifecycleState ListNetworkLoadBalancersLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// 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).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page from which to start retrieving results.
// 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).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' (ascending) or 'desc' (descending).
SortOrder ListNetworkLoadBalancersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.
// The default order for displayName is ascending. If no value is specified, then timeCreated is the default.
SortBy ListNetworkLoadBalancersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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 ListNetworkLoadBalancersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListNetworkLoadBalancersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListNetworkLoadBalancersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListNetworkLoadBalancersRequest) String() string
func (request ListNetworkLoadBalancersRequest) 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
ListNetworkLoadBalancersResponse wrapper for the ListNetworkLoadBalancers operation
type ListNetworkLoadBalancersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of NetworkLoadBalancerCollection instances
NetworkLoadBalancerCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListNetworkLoadBalancersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListNetworkLoadBalancersResponse) String() string
ListNetworkLoadBalancersSortByEnum Enum with underlying type: string
type ListNetworkLoadBalancersSortByEnum string
Set of constants representing the allowable values for ListNetworkLoadBalancersSortByEnum
const (
ListNetworkLoadBalancersSortByTimecreated ListNetworkLoadBalancersSortByEnum = "timeCreated"
ListNetworkLoadBalancersSortByDisplayname ListNetworkLoadBalancersSortByEnum = "displayName"
)
func GetListNetworkLoadBalancersSortByEnumValues() []ListNetworkLoadBalancersSortByEnum
GetListNetworkLoadBalancersSortByEnumValues Enumerates the set of values for ListNetworkLoadBalancersSortByEnum
func GetMappingListNetworkLoadBalancersSortByEnum(val string) (ListNetworkLoadBalancersSortByEnum, bool)
GetMappingListNetworkLoadBalancersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListNetworkLoadBalancersSortOrderEnum Enum with underlying type: string
type ListNetworkLoadBalancersSortOrderEnum string
Set of constants representing the allowable values for ListNetworkLoadBalancersSortOrderEnum
const (
ListNetworkLoadBalancersSortOrderAsc ListNetworkLoadBalancersSortOrderEnum = "ASC"
ListNetworkLoadBalancersSortOrderDesc ListNetworkLoadBalancersSortOrderEnum = "DESC"
)
func GetListNetworkLoadBalancersSortOrderEnumValues() []ListNetworkLoadBalancersSortOrderEnum
GetListNetworkLoadBalancersSortOrderEnumValues Enumerates the set of values for ListNetworkLoadBalancersSortOrderEnum
func GetMappingListNetworkLoadBalancersSortOrderEnum(val string) (ListNetworkLoadBalancersSortOrderEnum, bool)
GetMappingListNetworkLoadBalancersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The identifier of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page from which to start retrieving results.
// 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).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) 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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The identifier of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page from which to start retrieving results.
// 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).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) 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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) 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/networkloadbalancer/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 compartment containing the network load balancers to list.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page from which to start retrieving results.
// 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).
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 WorkRequestCollection instances
WorkRequestCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
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 congfiguration of the listener. For more information about listener configuration, see Managing Load Balancer Listeners (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/Listeners/listener-management.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.
// For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port.
// For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true).
// "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead.
// Example: `TCP`
Protocol ListenerProtocolsEnum `mandatory:"true" json:"protocol"`
// IP version associated with the listener.
IpVersion IpVersionEnum `mandatory:"false" json:"ipVersion,omitempty"`
}
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
ListenerCollection Wrapper object for an array of ListenerSummary objects.
type ListenerCollection struct {
// Array of ListenerSummary objects.
Items []ListenerSummary `mandatory:"false" json:"items"`
}
func (m ListenerCollection) String() string
func (m ListenerCollection) 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. For more information about listener configuration, see Managing Load Balancer Listeners (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/Listeners/listener-management.htm).
type ListenerDetails 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.
// For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port.
// For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true).
// "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead.
// Example: `TCP`
Protocol ListenerProtocolsEnum `mandatory:"true" json:"protocol"`
// IP version associated with the listener.
IpVersion IpVersionEnum `mandatory:"false" json:"ipVersion,omitempty"`
}
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
ListenerProtocolsEnum Enum with underlying type: string
type ListenerProtocolsEnum string
Set of constants representing the allowable values for ListenerProtocolsEnum
const (
ListenerProtocolsAny ListenerProtocolsEnum = "ANY"
ListenerProtocolsTcp ListenerProtocolsEnum = "TCP"
ListenerProtocolsUdp ListenerProtocolsEnum = "UDP"
ListenerProtocolsTcpAndUdp ListenerProtocolsEnum = "TCP_AND_UDP"
)
func GetListenerProtocolsEnumValues() []ListenerProtocolsEnum
GetListenerProtocolsEnumValues Enumerates the set of values for ListenerProtocolsEnum
func GetMappingListenerProtocolsEnum(val string) (ListenerProtocolsEnum, bool)
GetMappingListenerProtocolsEnum performs case Insensitive comparison on enum value and return the desired enum
ListenerSummary The configuration of the listener. For more information about listener configuration, see Managing Load Balancer Listeners (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/Listeners/listener-management.htm).
type ListenerSummary 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.
// For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port.
// For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true).
// "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead.
// Example: `TCP`
Protocol ListenerProtocolsEnum `mandatory:"true" json:"protocol"`
// IP version associated with the listener.
IpVersion IpVersionEnum `mandatory:"false" json:"ipVersion,omitempty"`
}
func (m ListenerSummary) String() string
func (m ListenerSummary) 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
NetworkLoadBalancer The properties that define a network load balancer. For more information, see Managing a network load balancer (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/NetworkLoadBalancers/network-load-balancer-management.htm). To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who writes policies to give users access, then 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 NetworkLoadBalancer struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network 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 network load balancer.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name, which does not have to be unique, and can be changed.
// Example: `example_load_balancer`
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the network load balancer.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the network load balancer was created, in the format defined by RFC3339.
// Example: `2020-05-01T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// An array of IP addresses.
IpAddresses []IpAddress `mandatory:"true" json:"ipAddresses"`
// The subnet in which the network load balancer is spawned OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)."
SubnetId *string `mandatory:"true" json:"subnetId"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// IP version associated with the NLB.
NlbIpVersion NlbIpVersionEnum `mandatory:"false" json:"nlbIpVersion,omitempty"`
// The time the network load balancer was updated. An RFC3339 formatted date-time string.
// Example: `2020-05-01T22:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Whether the network load balancer has a virtual cloud network-local (private) IP address.
// If "true", then the service assigns a private IP address to the network load balancer.
// If "false", then the service assigns a public IP address to the network load balancer.
// A public network load balancer is accessible from the internet, depending the
// security list rules (https://docs.cloud.oracle.com/Content/network/Concepts/securitylists.htm) for your virtual cloudn network. For more information about public and
// private network load balancers,
// see How Network Load Balancing Works (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/overview.htm).
// This value is true by default.
// Example: `true`
IsPrivate *bool `mandatory:"false" json:"isPrivate"`
// When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC.
// Packets are sent to the backend set without any changes to the source and destination IP.
IsPreserveSourceDestination *bool `mandatory:"false" json:"isPreserveSourceDestination"`
// This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled.
// This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.
IsSymmetricHashEnabled *bool `mandatory:"false" json:"isSymmetricHashEnabled"`
// An array of network security groups OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with the network load
// balancer.
// During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.
// The benefits of associating the network load balancer with network security groups include:
// * Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
// * The network security rules of other resources can reference the network security groups associated with the network load balancer
// to ensure access.
// Example: ["ocid1.nsg.oc1.phx.unique_ID"]
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
// Listeners associated with the network load balancer.
Listeners map[string]Listener `mandatory:"false" json:"listeners"`
// Backend sets associated with the network load balancer.
BackendSets map[string]BackendSet `mandatory:"false" json:"backendSets"`
// 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"`
// Key-value pair representing system tags' keys and values scoped to a namespace.
// Example: `{"bar-key": "value"}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m NetworkLoadBalancer) String() string
func (m NetworkLoadBalancer) 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
NetworkLoadBalancerClient a client for NetworkLoadBalancer
type NetworkLoadBalancerClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewNetworkLoadBalancerClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client NetworkLoadBalancerClient, err error)
NewNetworkLoadBalancerClientWithConfigurationProvider Creates a new default NetworkLoadBalancer client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewNetworkLoadBalancerClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client NetworkLoadBalancerClient, err error)
NewNetworkLoadBalancerClientWithOboToken Creates a new default NetworkLoadBalancer 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 NetworkLoadBalancerClient) ChangeNetworkLoadBalancerCompartment(ctx context.Context, request ChangeNetworkLoadBalancerCompartmentRequest) (response ChangeNetworkLoadBalancerCompartmentResponse, err error)
ChangeNetworkLoadBalancerCompartment Moves a network 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/networkloadbalancer/ChangeNetworkLoadBalancerCompartment.go.html to see an example of how to use ChangeNetworkLoadBalancerCompartment API. A default retry strategy applies to this operation ChangeNetworkLoadBalancerCompartment()
func (client *NetworkLoadBalancerClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client NetworkLoadBalancerClient) 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/networkloadbalancer/CreateBackend.go.html to see an example of how to use CreateBackend API. A default retry strategy applies to this operation CreateBackend()
func (client NetworkLoadBalancerClient) CreateBackendSet(ctx context.Context, request CreateBackendSetRequest) (response CreateBackendSetResponse, err error)
CreateBackendSet Adds a backend set to a network load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/CreateBackendSet.go.html to see an example of how to use CreateBackendSet API. A default retry strategy applies to this operation CreateBackendSet()
func (client NetworkLoadBalancerClient) CreateListener(ctx context.Context, request CreateListenerRequest) (response CreateListenerResponse, err error)
CreateListener Adds a listener to a network load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/CreateListener.go.html to see an example of how to use CreateListener API. A default retry strategy applies to this operation CreateListener()
func (client NetworkLoadBalancerClient) CreateNetworkLoadBalancer(ctx context.Context, request CreateNetworkLoadBalancerRequest) (response CreateNetworkLoadBalancerResponse, err error)
CreateNetworkLoadBalancer Creates a network load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/CreateNetworkLoadBalancer.go.html to see an example of how to use CreateNetworkLoadBalancer API. A default retry strategy applies to this operation CreateNetworkLoadBalancer()
func (client NetworkLoadBalancerClient) DeleteBackend(ctx context.Context, request DeleteBackendRequest) (response DeleteBackendResponse, err error)
DeleteBackend Removes a backend server from a given network load balancer and backend set.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/DeleteBackend.go.html to see an example of how to use DeleteBackend API. A default retry strategy applies to this operation DeleteBackend()
func (client NetworkLoadBalancerClient) 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 network 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/networkloadbalancer/DeleteBackendSet.go.html to see an example of how to use DeleteBackendSet API. A default retry strategy applies to this operation DeleteBackendSet()
func (client NetworkLoadBalancerClient) DeleteListener(ctx context.Context, request DeleteListenerRequest) (response DeleteListenerResponse, err error)
DeleteListener Deletes a listener from a network load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/DeleteListener.go.html to see an example of how to use DeleteListener API. A default retry strategy applies to this operation DeleteListener()
func (client NetworkLoadBalancerClient) DeleteNetworkLoadBalancer(ctx context.Context, request DeleteNetworkLoadBalancerRequest) (response DeleteNetworkLoadBalancerResponse, err error)
DeleteNetworkLoadBalancer Deletes a network load balancer resource by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/DeleteNetworkLoadBalancer.go.html to see an example of how to use DeleteNetworkLoadBalancer API. A default retry strategy applies to this operation DeleteNetworkLoadBalancer()
func (client NetworkLoadBalancerClient) GetBackend(ctx context.Context, request GetBackendRequest) (response GetBackendResponse, err error)
GetBackend Retrieves the configuration information for the specified backend server.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/GetBackend.go.html to see an example of how to use GetBackend API. A default retry strategy applies to this operation GetBackend()
func (client NetworkLoadBalancerClient) GetBackendHealth(ctx context.Context, request GetBackendHealthRequest) (response GetBackendHealthResponse, err error)
GetBackendHealth Retrieves 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/networkloadbalancer/GetBackendHealth.go.html to see an example of how to use GetBackendHealth API. A default retry strategy applies to this operation GetBackendHealth()
func (client NetworkLoadBalancerClient) GetBackendSet(ctx context.Context, request GetBackendSetRequest) (response GetBackendSetResponse, err error)
GetBackendSet Retrieves the configuration information for the specified backend set.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/GetBackendSet.go.html to see an example of how to use GetBackendSet API. A default retry strategy applies to this operation GetBackendSet()
func (client NetworkLoadBalancerClient) GetBackendSetHealth(ctx context.Context, request GetBackendSetHealthRequest) (response GetBackendSetHealthResponse, err error)
GetBackendSetHealth Retrieves 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/networkloadbalancer/GetBackendSetHealth.go.html to see an example of how to use GetBackendSetHealth API. A default retry strategy applies to this operation GetBackendSetHealth()
func (client NetworkLoadBalancerClient) GetHealthChecker(ctx context.Context, request GetHealthCheckerRequest) (response GetHealthCheckerResponse, err error)
GetHealthChecker Retrieves the health check policy information for a given network load balancer and backend set.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/GetHealthChecker.go.html to see an example of how to use GetHealthChecker API. A default retry strategy applies to this operation GetHealthChecker()
func (client NetworkLoadBalancerClient) GetListener(ctx context.Context, request GetListenerRequest) (response GetListenerResponse, err error)
GetListener Retrieves listener properties associated with a given network load balancer and listener name.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/GetListener.go.html to see an example of how to use GetListener API. A default retry strategy applies to this operation GetListener()
func (client NetworkLoadBalancerClient) GetNetworkLoadBalancer(ctx context.Context, request GetNetworkLoadBalancerRequest) (response GetNetworkLoadBalancerResponse, err error)
GetNetworkLoadBalancer Retrieves network load balancer configuration information by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/GetNetworkLoadBalancer.go.html to see an example of how to use GetNetworkLoadBalancer API. A default retry strategy applies to this operation GetNetworkLoadBalancer()
func (client NetworkLoadBalancerClient) GetNetworkLoadBalancerHealth(ctx context.Context, request GetNetworkLoadBalancerHealthRequest) (response GetNetworkLoadBalancerHealthResponse, err error)
GetNetworkLoadBalancerHealth Retrieves the health status for the specified network load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/GetNetworkLoadBalancerHealth.go.html to see an example of how to use GetNetworkLoadBalancerHealth API. A default retry strategy applies to this operation GetNetworkLoadBalancerHealth()
func (client NetworkLoadBalancerClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Retrieves the details of the work request with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client NetworkLoadBalancerClient) ListBackendSets(ctx context.Context, request ListBackendSetsRequest) (response ListBackendSetsResponse, err error)
ListBackendSets Lists all backend sets associated with a given network load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListBackendSets.go.html to see an example of how to use ListBackendSets API. A default retry strategy applies to this operation ListBackendSets()
func (client NetworkLoadBalancerClient) ListBackends(ctx context.Context, request ListBackendsRequest) (response ListBackendsResponse, err error)
ListBackends Lists the backend servers for a given network load balancer and backend set.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListBackends.go.html to see an example of how to use ListBackends API. A default retry strategy applies to this operation ListBackends()
func (client NetworkLoadBalancerClient) ListListeners(ctx context.Context, request ListListenersRequest) (response ListListenersResponse, err error)
ListListeners Lists all listeners associated with a given network load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListListeners.go.html to see an example of how to use ListListeners API. A default retry strategy applies to this operation ListListeners()
func (client NetworkLoadBalancerClient) ListNetworkLoadBalancerHealths(ctx context.Context, request ListNetworkLoadBalancerHealthsRequest) (response ListNetworkLoadBalancerHealthsResponse, err error)
ListNetworkLoadBalancerHealths Lists the summary health statuses for all network load balancers in the specified compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListNetworkLoadBalancerHealths.go.html to see an example of how to use ListNetworkLoadBalancerHealths API. A default retry strategy applies to this operation ListNetworkLoadBalancerHealths()
func (client NetworkLoadBalancerClient) ListNetworkLoadBalancers(ctx context.Context, request ListNetworkLoadBalancersRequest) (response ListNetworkLoadBalancersResponse, err error)
ListNetworkLoadBalancers Returns a list of network load balancers.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListNetworkLoadBalancers.go.html to see an example of how to use ListNetworkLoadBalancers API. A default retry strategy applies to this operation ListNetworkLoadBalancers()
func (client NetworkLoadBalancerClient) ListNetworkLoadBalancersPolicies(ctx context.Context, request ListNetworkLoadBalancersPoliciesRequest) (response ListNetworkLoadBalancersPoliciesResponse, err error)
ListNetworkLoadBalancersPolicies Lists the available network load balancer policies.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListNetworkLoadBalancersPolicies.go.html to see an example of how to use ListNetworkLoadBalancersPolicies API. A default retry strategy applies to this operation ListNetworkLoadBalancersPolicies()
func (client NetworkLoadBalancerClient) ListNetworkLoadBalancersProtocols(ctx context.Context, request ListNetworkLoadBalancersProtocolsRequest) (response ListNetworkLoadBalancersProtocolsResponse, err error)
ListNetworkLoadBalancersProtocols This API has been deprecated so it won't return the updated list of supported protocls. Lists all supported traffic protocols.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListNetworkLoadBalancersProtocols.go.html to see an example of how to use ListNetworkLoadBalancersProtocols API. A default retry strategy applies to this operation ListNetworkLoadBalancersProtocols()
func (client NetworkLoadBalancerClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Return a (paginated) list of errors for a given work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client NetworkLoadBalancerClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a (paginated) list of logs for a given work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client NetworkLoadBalancerClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists all work requests.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *NetworkLoadBalancerClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client NetworkLoadBalancerClient) 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/networkloadbalancer/UpdateBackend.go.html to see an example of how to use UpdateBackend API. A default retry strategy applies to this operation UpdateBackend()
func (client NetworkLoadBalancerClient) 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/networkloadbalancer/UpdateBackendSet.go.html to see an example of how to use UpdateBackendSet API. A default retry strategy applies to this operation UpdateBackendSet()
func (client NetworkLoadBalancerClient) UpdateHealthChecker(ctx context.Context, request UpdateHealthCheckerRequest) (response UpdateHealthCheckerResponse, err error)
UpdateHealthChecker Updates the health check policy for a given network load balancer and backend set.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/UpdateHealthChecker.go.html to see an example of how to use UpdateHealthChecker API. A default retry strategy applies to this operation UpdateHealthChecker()
func (client NetworkLoadBalancerClient) UpdateListener(ctx context.Context, request UpdateListenerRequest) (response UpdateListenerResponse, err error)
UpdateListener Updates a listener for a given network load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/UpdateListener.go.html to see an example of how to use UpdateListener API. A default retry strategy applies to this operation UpdateListener()
func (client NetworkLoadBalancerClient) UpdateNetworkLoadBalancer(ctx context.Context, request UpdateNetworkLoadBalancerRequest) (response UpdateNetworkLoadBalancerResponse, err error)
UpdateNetworkLoadBalancer Updates the network load balancer
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/UpdateNetworkLoadBalancer.go.html to see an example of how to use UpdateNetworkLoadBalancer API. A default retry strategy applies to this operation UpdateNetworkLoadBalancer()
func (client NetworkLoadBalancerClient) UpdateNetworkSecurityGroups(ctx context.Context, request UpdateNetworkSecurityGroupsRequest) (response UpdateNetworkSecurityGroupsResponse, err error)
UpdateNetworkSecurityGroups Updates the network security groups associated with the specified network load balancer.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/UpdateNetworkSecurityGroups.go.html to see an example of how to use UpdateNetworkSecurityGroups API. A default retry strategy applies to this operation UpdateNetworkSecurityGroups()
NetworkLoadBalancerCollection Wrapper object for an array of NetworkLoadBalancerSummary objects.
type NetworkLoadBalancerCollection struct {
// Array of NetworkLoadBalancerSummary objects.
Items []NetworkLoadBalancerSummary `mandatory:"false" json:"items"`
}
func (m NetworkLoadBalancerCollection) String() string
func (m NetworkLoadBalancerCollection) 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
NetworkLoadBalancerHealth The health status details for the specified network load balancer. This object does not explicitly enumerate backend sets with a status of `OK`. However, the backend sets are included in the `totalBackendSetCount` sum.
type NetworkLoadBalancerHealth struct {
// The overall health status of the network load balancer.
// * **OK:** All backend sets associated with the network load balancer return a status of `OK`.
// * **WARNING:** At least one of the backend sets associated with the network load balancer returns a status of `WARNING`,
// no backend sets return a status of `CRITICAL`, and the network load balancer life cycle state is `ACTIVE`.
// * **CRITICAL:** One or more of the backend sets associated with the network load balancer return a status of `CRITICAL`.
// * **UNKNOWN:** If any one of the following conditions is true:
// * The network load balancer life cycle state is not `ACTIVE`.
// * No backend sets are defined for the network load balancer.
// * More than half of the backend sets associated with the network load balancer return a status of `UNKNOWN`, none of the backend
// sets return a status of `WARNING` or `CRITICAL`, and the network load balancer life cycle state is `ACTIVE`.
// * The system could not retrieve metrics for any reason.
Status NetworkLoadBalancerHealthStatusEnum `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
// user-friendly name you assigned when you created the backend set.
// 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
// user-friendly name you assigned when you created the backend set.
// 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
// user-friendly name you assigned when you created the backend set.
// Example: `example_backend_set2`
UnknownStateBackendSetNames []string `mandatory:"true" json:"unknownStateBackendSetNames"`
// The total number of backend sets associated with this network load balancer.
// Example: `4`
TotalBackendSetCount *int `mandatory:"true" json:"totalBackendSetCount"`
}
func (m NetworkLoadBalancerHealth) String() string
func (m NetworkLoadBalancerHealth) 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
NetworkLoadBalancerHealthCollection Wrapper object for an array of NetworkLoadBalancerHealthSummary objects.
type NetworkLoadBalancerHealthCollection struct {
// An array of BackendSetSummary objects.
Items []NetworkLoadBalancerHealthSummary `mandatory:"false" json:"items"`
}
func (m NetworkLoadBalancerHealthCollection) String() string
func (m NetworkLoadBalancerHealthCollection) 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
NetworkLoadBalancerHealthStatusEnum Enum with underlying type: string
type NetworkLoadBalancerHealthStatusEnum string
Set of constants representing the allowable values for NetworkLoadBalancerHealthStatusEnum
const (
NetworkLoadBalancerHealthStatusOk NetworkLoadBalancerHealthStatusEnum = "OK"
NetworkLoadBalancerHealthStatusWarning NetworkLoadBalancerHealthStatusEnum = "WARNING"
NetworkLoadBalancerHealthStatusCritical NetworkLoadBalancerHealthStatusEnum = "CRITICAL"
NetworkLoadBalancerHealthStatusUnknown NetworkLoadBalancerHealthStatusEnum = "UNKNOWN"
)
func GetMappingNetworkLoadBalancerHealthStatusEnum(val string) (NetworkLoadBalancerHealthStatusEnum, bool)
GetMappingNetworkLoadBalancerHealthStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNetworkLoadBalancerHealthStatusEnumValues() []NetworkLoadBalancerHealthStatusEnum
GetNetworkLoadBalancerHealthStatusEnumValues Enumerates the set of values for NetworkLoadBalancerHealthStatusEnum
NetworkLoadBalancerHealthSummary A health status summary for the specified network load balancer
type NetworkLoadBalancerHealthSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer with which the health status is associated.
NetworkLoadBalancerId *string `mandatory:"true" json:"networkLoadBalancerId"`
// The overall health status of the network load balancer.
// * **OK:** All backend sets associated with the network load balancer return a status of `OK`.
// * **WARNING:** At least one of the backend sets associated with the network load balancer returns a status of `WARNING`,
// no backend sets return a status of `CRITICAL`, and the network load balancer life cycle state is `ACTIVE`.
// * **CRITICAL:** One or more of the backend sets associated with the network load balancer returns a status of `CRITICAL`.
// * **UNKNOWN:** If any one of the following conditions is true:
// * The network load balancer life cycle state is not `ACTIVE`.
// * No backend sets are defined for the network load balancer.
// * More than half of the backend sets associated with the network load balancer return a status of `UNKNOWN`, none of the backend
// sets returns a status of `WARNING` or `CRITICAL`, and the network load balancer life cycle state is `ACTIVE`.
// * The system could not retrieve metrics for any reason.
Status NetworkLoadBalancerHealthSummaryStatusEnum `mandatory:"true" json:"status"`
}
func (m NetworkLoadBalancerHealthSummary) String() string
func (m NetworkLoadBalancerHealthSummary) 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
NetworkLoadBalancerHealthSummaryStatusEnum Enum with underlying type: string
type NetworkLoadBalancerHealthSummaryStatusEnum string
Set of constants representing the allowable values for NetworkLoadBalancerHealthSummaryStatusEnum
const (
NetworkLoadBalancerHealthSummaryStatusOk NetworkLoadBalancerHealthSummaryStatusEnum = "OK"
NetworkLoadBalancerHealthSummaryStatusWarning NetworkLoadBalancerHealthSummaryStatusEnum = "WARNING"
NetworkLoadBalancerHealthSummaryStatusCritical NetworkLoadBalancerHealthSummaryStatusEnum = "CRITICAL"
NetworkLoadBalancerHealthSummaryStatusUnknown NetworkLoadBalancerHealthSummaryStatusEnum = "UNKNOWN"
)
func GetMappingNetworkLoadBalancerHealthSummaryStatusEnum(val string) (NetworkLoadBalancerHealthSummaryStatusEnum, bool)
GetMappingNetworkLoadBalancerHealthSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNetworkLoadBalancerHealthSummaryStatusEnumValues() []NetworkLoadBalancerHealthSummaryStatusEnum
GetNetworkLoadBalancerHealthSummaryStatusEnumValues Enumerates the set of values for NetworkLoadBalancerHealthSummaryStatusEnum
NetworkLoadBalancerSummary Network load balancer object to be used for list operations.
type NetworkLoadBalancerSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network 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 network load balancer.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name, which does not have to be unique, and can be changed.
// Example: `example_load_balancer`
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the network load balancer.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the network load balancer was created, in the format defined by RFC3339.
// Example: `2020-05-01T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// An array of IP addresses.
IpAddresses []IpAddress `mandatory:"true" json:"ipAddresses"`
// The subnet in which the network load balancer is spawned OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)."
SubnetId *string `mandatory:"true" json:"subnetId"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// IP version associated with the NLB.
NlbIpVersion NlbIpVersionEnum `mandatory:"false" json:"nlbIpVersion,omitempty"`
// The time the network load balancer was updated. An RFC3339 formatted date-time string.
// Example: `2020-05-01T22:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Whether the network load balancer has a virtual cloud network-local (private) IP address.
// If "true", then the service assigns a private IP address to the network load balancer.
// If "false", then the service assigns a public IP address to the network load balancer.
// A public network load balancer is accessible from the internet, depending the
// security list rules (https://docs.cloud.oracle.com/Content/network/Concepts/securitylists.htm) for your virtual cloudn network. For more information about public and
// private network load balancers,
// see How Network Load Balancing Works (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/overview.htm).
// This value is true by default.
// Example: `true`
IsPrivate *bool `mandatory:"false" json:"isPrivate"`
// When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC.
// Packets are sent to the backend set without any changes to the source and destination IP.
IsPreserveSourceDestination *bool `mandatory:"false" json:"isPreserveSourceDestination"`
// This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled.
// This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.
IsSymmetricHashEnabled *bool `mandatory:"false" json:"isSymmetricHashEnabled"`
// An array of network security groups OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with the network load
// balancer.
// During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.
// The benefits of associating the network load balancer with network security groups include:
// * Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
// * The network security rules of other resources can reference the network security groups associated with the network load balancer
// to ensure access.
// Example: ["ocid1.nsg.oc1.phx.unique_ID"]
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
// Listeners associated with the network load balancer.
Listeners map[string]Listener `mandatory:"false" json:"listeners"`
// Backend sets associated with the network load balancer.
BackendSets map[string]BackendSet `mandatory:"false" json:"backendSets"`
// 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"`
// Key-value pair representing system tags' keys and values scoped to a namespace.
// Example: `{"bar-key": "value"}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m NetworkLoadBalancerSummary) String() string
func (m NetworkLoadBalancerSummary) 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
NetworkLoadBalancersPolicyCollection Wrapper object for array of NetworkLoadBalancersPolicySummary objects.
type NetworkLoadBalancersPolicyCollection struct {
// Array of NetworkLoadBalancersPolicySummary objects.
Items []NetworkLoadBalancersPolicySummaryEnum `mandatory:"false" json:"items"`
}
func (m NetworkLoadBalancersPolicyCollection) String() string
func (m NetworkLoadBalancersPolicyCollection) 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
NetworkLoadBalancersPolicySummaryEnum Enum with underlying type: string
type NetworkLoadBalancersPolicySummaryEnum string
Set of constants representing the allowable values for NetworkLoadBalancersPolicySummaryEnum
const (
NetworkLoadBalancersPolicySummaryTwoTuple NetworkLoadBalancersPolicySummaryEnum = "TWO_TUPLE"
NetworkLoadBalancersPolicySummaryThreeTuple NetworkLoadBalancersPolicySummaryEnum = "THREE_TUPLE"
NetworkLoadBalancersPolicySummaryFiveTuple NetworkLoadBalancersPolicySummaryEnum = "FIVE_TUPLE"
)
func GetMappingNetworkLoadBalancersPolicySummaryEnum(val string) (NetworkLoadBalancersPolicySummaryEnum, bool)
GetMappingNetworkLoadBalancersPolicySummaryEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNetworkLoadBalancersPolicySummaryEnumValues() []NetworkLoadBalancersPolicySummaryEnum
GetNetworkLoadBalancersPolicySummaryEnumValues Enumerates the set of values for NetworkLoadBalancersPolicySummaryEnum
NetworkLoadBalancersProtocolCollection This object is deprecated. Wrapper object for array of ProtocolSummary objects.
type NetworkLoadBalancersProtocolCollection struct {
// Array of NetworkLoadBalancersProtocolSummary objects.
Items []NetworkLoadBalancersProtocolSummaryEnum `mandatory:"false" json:"items"`
}
func (m NetworkLoadBalancersProtocolCollection) String() string
func (m NetworkLoadBalancersProtocolCollection) 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
NetworkLoadBalancersProtocolSummaryEnum Enum with underlying type: string
type NetworkLoadBalancersProtocolSummaryEnum string
Set of constants representing the allowable values for NetworkLoadBalancersProtocolSummaryEnum
const (
NetworkLoadBalancersProtocolSummaryAny NetworkLoadBalancersProtocolSummaryEnum = "ANY"
NetworkLoadBalancersProtocolSummaryTcp NetworkLoadBalancersProtocolSummaryEnum = "TCP"
NetworkLoadBalancersProtocolSummaryUdp NetworkLoadBalancersProtocolSummaryEnum = "UDP"
NetworkLoadBalancersProtocolSummaryTcpAndUdp NetworkLoadBalancersProtocolSummaryEnum = "TCP_AND_UDP"
)
func GetMappingNetworkLoadBalancersProtocolSummaryEnum(val string) (NetworkLoadBalancersProtocolSummaryEnum, bool)
GetMappingNetworkLoadBalancersProtocolSummaryEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNetworkLoadBalancersProtocolSummaryEnumValues() []NetworkLoadBalancersProtocolSummaryEnum
GetNetworkLoadBalancersProtocolSummaryEnumValues Enumerates the set of values for NetworkLoadBalancersProtocolSummaryEnum
NetworkLoadBalancingPolicyEnum Enum with underlying type: string
type NetworkLoadBalancingPolicyEnum string
Set of constants representing the allowable values for NetworkLoadBalancingPolicyEnum
const (
NetworkLoadBalancingPolicyTwoTuple NetworkLoadBalancingPolicyEnum = "TWO_TUPLE"
NetworkLoadBalancingPolicyThreeTuple NetworkLoadBalancingPolicyEnum = "THREE_TUPLE"
NetworkLoadBalancingPolicyFiveTuple NetworkLoadBalancingPolicyEnum = "FIVE_TUPLE"
)
func GetMappingNetworkLoadBalancingPolicyEnum(val string) (NetworkLoadBalancingPolicyEnum, bool)
GetMappingNetworkLoadBalancingPolicyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNetworkLoadBalancingPolicyEnumValues() []NetworkLoadBalancingPolicyEnum
GetNetworkLoadBalancingPolicyEnumValues Enumerates the set of values for NetworkLoadBalancingPolicyEnum
NlbIpVersionEnum Enum with underlying type: string
type NlbIpVersionEnum string
Set of constants representing the allowable values for NlbIpVersionEnum
const (
NlbIpVersionIpv4 NlbIpVersionEnum = "IPV4"
NlbIpVersionIpv4AndIpv6 NlbIpVersionEnum = "IPV4_AND_IPV6"
NlbIpVersionIpv6 NlbIpVersionEnum = "IPV6"
)
func GetMappingNlbIpVersionEnum(val string) (NlbIpVersionEnum, bool)
GetMappingNlbIpVersionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNlbIpVersionEnumValues() []NlbIpVersionEnum
GetNlbIpVersionEnumValues Enumerates the set of values for NlbIpVersionEnum
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateNetworkLoadBalancer OperationTypeEnum = "CREATE_NETWORK_LOAD_BALANCER"
OperationTypeUpdateNetworkLoadBalancer OperationTypeEnum = "UPDATE_NETWORK_LOAD_BALANCER"
OperationTypeDeleteNetworkLoadBalancer OperationTypeEnum = "DELETE_NETWORK_LOAD_BALANCER"
OperationTypeCreateBackend OperationTypeEnum = "CREATE_BACKEND"
OperationTypeUpdateBackend OperationTypeEnum = "UPDATE_BACKEND"
OperationTypeDeleteBackend OperationTypeEnum = "DELETE_BACKEND"
OperationTypeCreateListener OperationTypeEnum = "CREATE_LISTENER"
OperationTypeUpdateListener OperationTypeEnum = "UPDATE_LISTENER"
OperationTypeDeleteListener OperationTypeEnum = "DELETE_LISTENER"
OperationTypeCreateBackendset OperationTypeEnum = "CREATE_BACKENDSET"
OperationTypeUpdateBackendset OperationTypeEnum = "UPDATE_BACKENDSET"
OperationTypeDeleteBackendset OperationTypeEnum = "DELETE_BACKENDSET"
OperationTypeUpdateNsgs OperationTypeEnum = "UPDATE_NSGS"
OperationTypeUpdateHealthChecker OperationTypeEnum = "UPDATE_HEALTH_CHECKER"
OperationTypeChangeCompartment OperationTypeEnum = "CHANGE_COMPARTMENT"
OperationTypeAttachNlbToPod OperationTypeEnum = "ATTACH_NLB_TO_POD"
OperationTypeDetachNlbFromPod OperationTypeEnum = "DETACH_NLB_FROM_POD"
OperationTypeLiveMigration OperationTypeEnum = "LIVE_MIGRATION"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
ReservedIp An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
type ReservedIp struct {
// OCID of the reserved public IP address created with the virtual cloud network.
// Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.
// Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the
// reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.
// Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.
// Example: "ocid1.publicip.oc1.phx.unique_ID"
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
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
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 three times the number of new connections
// as a server weighted '1'.
// For more information about load balancing policies, see
// How Network Load Balancing Policies Work (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/introducton.htm#Policies).
// Example: `3`
Weight *int `mandatory:"false" json:"weight"`
// Whether the network load balancer should treat this server as a backup unit. If `true`, then the network load balancer forwards no ingress
// traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy.
// Example: `false`
IsBackup *bool `mandatory:"false" json:"isBackup"`
// Whether the network load balancer should drain this server. Servers marked "isDrain" receive no
// incoming traffic.
// Example: `false`
IsDrain *bool `mandatory:"false" json:"isDrain"`
// Whether the network load balancer should treat this server as offline. Offline servers receive no incoming
// traffic.
// Example: `false`
IsOffline *bool `mandatory:"false" json:"isOffline"`
}
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/networkloadbalancer/UpdateBackend.go.html to see an example of how to use UpdateBackendRequest.
type UpdateBackendRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// Details for updating a backend server.
UpdateBackendDetails `contributesTo:"body"`
// The name of the backend set associated with the backend server.
// Example: `example_backend_set`
BackendSetName *string `mandatory:"true" contributesTo:"path" name:"backendSetName"`
// The name of the backend server to update.
// If the backend was created with an explicitly specified name, that name should be used here.
// If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>.
// If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>.
// Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var><unique_ID></var>:8080`
BackendName *string `mandatory:"true" contributesTo:"path" name:"backendName"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that it can be retried in case of a timeout or
// server error without risk of rerunning that same action. Retry tokens expire after 24
// hours but they can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might 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 from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
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
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
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 about backend set configuration, see Managing Backend Sets (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/BackendSets/backend-set-management.htm). **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type UpdateBackendSetDetails struct {
// The network load balancer policy for the backend set. To get a list of available policies, use the
// ListNetworkLoadBalancersPolicies operation.
// Example: `FIVE_TUPLE`
Policy *string `mandatory:"false" json:"policy"`
// If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends.
// Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled.
// The value is true by default.
IsPreserveSource *bool `mandatory:"false" json:"isPreserveSource"`
// If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy.
// The value is false by default.
IsFailOpen *bool `mandatory:"false" json:"isFailOpen"`
// If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
IsInstantFailoverEnabled *bool `mandatory:"false" json:"isInstantFailoverEnabled"`
// The IP version associated with the backend set.
IpVersion IpVersionEnum `mandatory:"false" json:"ipVersion,omitempty"`
// An array of backends associated with the backend set.
Backends []BackendDetails `mandatory:"false" json:"backends"`
HealthChecker *HealthCheckerDetails `mandatory:"false" json:"healthChecker"`
}
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/networkloadbalancer/UpdateBackendSet.go.html to see an example of how to use UpdateBackendSetRequest.
type UpdateBackendSetRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The details to update a backend set.
UpdateBackendSetDetails `contributesTo:"body"`
// 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 must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that it can be retried in case of a timeout or
// server error without risk of rerunning that same action. Retry tokens expire after 24
// hours but they can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might 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 from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
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
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
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 configuration details of the health checker.
type UpdateHealthCheckerDetails struct {
// The protocol that the health check must use; either HTTP, UDP, or TCP.
// Example: `HTTP`
Protocol HealthCheckProtocolsEnum `mandatory:"false" json:"protocol,omitempty"`
// The backend server port against which to run the health check.
// Example: `8080`
Port *int `mandatory:"false" json:"port"`
// 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"`
// The path against which to run the health check.
// Example: `/healthcheck`
UrlPath *string `mandatory:"false" json:"urlPath"`
// A regular expression for parsing the response body from the backend server.
// Example: `^((?!false).|\s)*$`
ResponseBodyRegex *string `mandatory:"false" json:"responseBodyRegex"`
// The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol,
// then you can use common HTTP status codes such as "200".
// Example: `200`
ReturnCode *int `mandatory:"false" json:"returnCode"`
// Base64 encoded pattern to be sent as UDP or TCP health check probe.
RequestData []byte `mandatory:"false" json:"requestData"`
// Base64 encoded pattern to be validated as UDP or TCP health check probe response.
ResponseData []byte `mandatory:"false" json:"responseData"`
Dns *DnsHealthCheckerDetails `mandatory:"false" json:"dns"`
}
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/networkloadbalancer/UpdateHealthChecker.go.html to see an example of how to use UpdateHealthCheckerRequest.
type UpdateHealthCheckerRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The health check policy configuration details.
UpdateHealthCheckerDetails `contributesTo:"body"`
// 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 must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that it can be retried in case of a timeout or
// server error without risk of rerunning that same action. Retry tokens expire after 24
// hours but they can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might 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 from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
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
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateHealthCheckerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateHealthCheckerResponse) String() string
UpdateListenerDetails The configuration of the listener. For more information about backend set configuration, see Managing Network Load Balancer Listeners (https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/Listeners/listener-management.htm).
type UpdateListenerDetails struct {
// The name of the associated backend set.
// Example: `example_backend_set`
DefaultBackendSetName *string `mandatory:"false" json:"defaultBackendSetName"`
// The communication port for the listener.
// Example: `80`
Port *int `mandatory:"false" json:"port"`
// The protocol on which the listener accepts connection requests.
// For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port.
// For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true).
// "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead.
// Example: `TCP`
Protocol ListenerProtocolsEnum `mandatory:"false" json:"protocol,omitempty"`
// IP version associated with the listener.
IpVersion IpVersionEnum `mandatory:"false" json:"ipVersion,omitempty"`
}
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/networkloadbalancer/UpdateListener.go.html to see an example of how to use UpdateListenerRequest.
type UpdateListenerRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// Details to update a listener.
UpdateListenerDetails `contributesTo:"body"`
// 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 must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that it can be retried in case of a timeout or
// server error without risk of rerunning that same action. Retry tokens expire after 24
// hours but they can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might 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 from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
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
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateListenerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateListenerResponse) String() string
UpdateNetworkLoadBalancerDetails Configuration details to update a network load balancer. **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type UpdateNetworkLoadBalancerDetails struct {
// The user-friendly display name for the network load balancer, which does not have to be unique and can be changed.
// Avoid entering confidential information.
// Example: `example_network_load_balancer`
DisplayName *string `mandatory:"false" json:"displayName"`
// This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically
// enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
IsPreserveSourceDestination *bool `mandatory:"false" json:"isPreserveSourceDestination"`
// This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled.
// This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.
IsSymmetricHashEnabled *bool `mandatory:"false" json:"isSymmetricHashEnabled"`
// IP version associated with the NLB.
NlbIpVersion NlbIpVersionEnum `mandatory:"false" json:"nlbIpVersion,omitempty"`
// IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.
SubnetIpv6Cidr *string `mandatory:"false" json:"subnetIpv6Cidr"`
// IPv6 address to be assigned to the network load balancer being created.
// This IP address has to be part of one of the prefixes supported by the subnet.
// Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
AssignedIpv6 *string `mandatory:"false" json:"assignedIpv6"`
// 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 UpdateNetworkLoadBalancerDetails) String() string
func (m UpdateNetworkLoadBalancerDetails) 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
UpdateNetworkLoadBalancerRequest wrapper for the UpdateNetworkLoadBalancer operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/networkloadbalancer/UpdateNetworkLoadBalancer.go.html to see an example of how to use UpdateNetworkLoadBalancerRequest.
type UpdateNetworkLoadBalancerRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The information to be updated.
UpdateNetworkLoadBalancerDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
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 UpdateNetworkLoadBalancerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateNetworkLoadBalancerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateNetworkLoadBalancerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateNetworkLoadBalancerRequest) String() string
func (request UpdateNetworkLoadBalancerRequest) 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
UpdateNetworkLoadBalancerResponse wrapper for the UpdateNetworkLoadBalancer operation
type UpdateNetworkLoadBalancerResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateNetworkLoadBalancerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateNetworkLoadBalancerResponse) String() string
UpdateNetworkSecurityGroupsDetails An object representing an updated list of network security groups that overwrites the existing list of network security groups. * If the network load balancer has no configured network security groups, then the network load balancer uses the network security groups in this list. * If the network load balancer has a list of configured network security groups, then this list replaces the existing list. * If the network load balancer has a list of configured network security groups and this list is empty, then the operation removes all of the network security groups associated with the network load balancer.
type UpdateNetworkSecurityGroupsDetails struct {
// An array of network security group OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with the network load
// balancer.
// During the creation of the network load balancer, the service adds the new network load balancer to the specified network security groups.
// The benefits of associating the network load balancer with network security groups include:
// * Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
// * The network security rules of other resources can reference the network security groups associated with the network 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/networkloadbalancer/UpdateNetworkSecurityGroups.go.html to see an example of how to use UpdateNetworkSecurityGroupsRequest.
type UpdateNetworkSecurityGroupsRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
NetworkLoadBalancerId *string `mandatory:"true" contributesTo:"path" name:"networkLoadBalancerId"`
// The details for updating the network security groups associated with the specified network load balancer.
UpdateNetworkSecurityGroupsDetails `contributesTo:"body"`
// The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
// particular request, then provide the request identifier.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that it can be retried in case of a timeout or
// server error without risk of rerunning that same action. Retry tokens expire after 24
// hours but they can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might 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 from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the current etag value of the resource.
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
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you must contact
// Oracle about a particular request, then provide the request identifier.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateNetworkSecurityGroupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateNetworkSecurityGroupsResponse) String() string
WorkRequest A description of work request status.
type WorkRequest struct {
// Type of work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The identifier of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the work request. Work requests are scoped to
// the same compartment as the resource that the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, then the service team must choose the primary
// resource whose compartment is to be used.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time that the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time that the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time that the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
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
WorkRequestCollection Wrapper object for an array of WorkRequest objects.
type WorkRequestCollection struct {
// An array of WorkRequest objects.
Items []WorkRequestSummary `mandatory:"false" json:"items"`
}
func (m WorkRequestCollection) String() string
func (m WorkRequestCollection) 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 error encountered while running a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed here:
// (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human-readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured in the form of an RFC3339 formatted date-time string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
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
WorkRequestErrorCollection Wrapper object for an array of WorkRequestErrorSummary objects.
type WorkRequestErrorCollection struct {
// An array of WorkRequestErrorSummary objects.
Items []WorkRequestError `mandatory:"false" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) 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
WorkRequestLogEntry A log message from the running of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written displayed as an RFC3339 formatted date-time string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) 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
WorkRequestLogEntryCollection Wrapper object for an array of WorkRequestLogEntry objects.
type WorkRequestLogEntryCollection struct {
// An array of WorkRequestLogEntry objects.
Items []WorkRequestLogEntry `mandatory:"false" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) 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
WorkRequestResource A resource that a work request creates or on which the work request operates.
type WorkRequestResource struct {
// The resource type that the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
// work is complete for that resource, at which point the resource transitions to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path on which the user can perform a GET request to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) 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
WorkRequestSummary Summary of work request object.
type WorkRequestSummary struct {
// Type of work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The identifier of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the work request. Work requests are scoped to
// the same compartment as the resource that the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, then the service team must choose the primary
// resource whose compartment is to be used.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time that the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time that the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time that the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) 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