GetCreateHttpMonitorDetailsMethodEnumValues Enumerates the set of values for HttpProbeMethodEnum Consider using GetHttpProbeMethodEnumValue Deprecated
var GetCreateHttpMonitorDetailsMethodEnumValues = GetHttpProbeMethodEnumValues
GetCreateHttpMonitorDetailsProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum Consider using GetHttpProbeProtocolEnumValue Deprecated
var GetCreateHttpMonitorDetailsProtocolEnumValues = GetHttpProbeProtocolEnumValues
GetCreateOnDemandHttpProbeDetailsMethodEnumValues Enumerates the set of values for HttpProbeMethodEnum Consider using GetHttpProbeMethodEnumValue Deprecated
var GetCreateOnDemandHttpProbeDetailsMethodEnumValues = GetHttpProbeMethodEnumValues
GetCreateOnDemandHttpProbeDetailsProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum Consider using GetHttpProbeProtocolEnumValue Deprecated
var GetCreateOnDemandHttpProbeDetailsProtocolEnumValues = GetHttpProbeProtocolEnumValues
GetCreateOnDemandPingProbeDetailsProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum Consider using GetPingProbeProtocolEnumValue Deprecated
var GetCreateOnDemandPingProbeDetailsProtocolEnumValues = GetPingProbeProtocolEnumValues
GetCreatePingMonitorDetailsProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum Consider using GetPingProbeProtocolEnumValue Deprecated
var GetCreatePingMonitorDetailsProtocolEnumValues = GetPingProbeProtocolEnumValues
GetHttpMonitorMethodEnumValues Enumerates the set of values for HttpProbeMethodEnum Consider using GetHttpProbeMethodEnumValue Deprecated
var GetHttpMonitorMethodEnumValues = GetHttpProbeMethodEnumValues
GetHttpMonitorProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum Consider using GetHttpProbeProtocolEnumValue Deprecated
var GetHttpMonitorProtocolEnumValues = GetHttpProbeProtocolEnumValues
GetHttpMonitorSummaryProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum Consider using GetHttpProbeProtocolEnumValue Deprecated
var GetHttpMonitorSummaryProtocolEnumValues = GetHttpProbeProtocolEnumValues
GetHttpProbeResultSummaryProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum Consider using GetHttpProbeProtocolEnumValue Deprecated
var GetHttpProbeResultSummaryProtocolEnumValues = GetHttpProbeProtocolEnumValues
GetPingMonitorProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum Consider using GetPingProbeProtocolEnumValue Deprecated
var GetPingMonitorProtocolEnumValues = GetPingProbeProtocolEnumValues
GetPingMonitorSummaryProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum Consider using GetPingProbeProtocolEnumValue Deprecated
var GetPingMonitorSummaryProtocolEnumValues = GetPingProbeProtocolEnumValues
GetPingProbeResultSummaryProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum Consider using GetPingProbeProtocolEnumValue Deprecated
var GetPingProbeResultSummaryProtocolEnumValues = GetPingProbeProtocolEnumValues
GetUpdateHttpMonitorDetailsMethodEnumValues Enumerates the set of values for HttpProbeMethodEnum Consider using GetHttpProbeMethodEnumValue Deprecated
var GetUpdateHttpMonitorDetailsMethodEnumValues = GetHttpProbeMethodEnumValues
GetUpdateHttpMonitorDetailsProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum Consider using GetHttpProbeProtocolEnumValue Deprecated
var GetUpdateHttpMonitorDetailsProtocolEnumValues = GetHttpProbeProtocolEnumValues
GetUpdatePingMonitorDetailsProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum Consider using GetPingProbeProtocolEnumValue Deprecated
var GetUpdatePingMonitorDetailsProtocolEnumValues = GetPingProbeProtocolEnumValues
func GetHttpProbeMethodEnumStringValues() []string
GetHttpProbeMethodEnumStringValues Enumerates the set of values in String for HttpProbeMethodEnum
func GetHttpProbeProtocolEnumStringValues() []string
GetHttpProbeProtocolEnumStringValues Enumerates the set of values in String for HttpProbeProtocolEnum
func GetHttpProbeResultSummaryErrorCategoryEnumStringValues() []string
GetHttpProbeResultSummaryErrorCategoryEnumStringValues Enumerates the set of values in String for HttpProbeResultSummaryErrorCategoryEnum
func GetListHealthChecksVantagePointsSortByEnumStringValues() []string
GetListHealthChecksVantagePointsSortByEnumStringValues Enumerates the set of values in String for ListHealthChecksVantagePointsSortByEnum
func GetListHealthChecksVantagePointsSortOrderEnumStringValues() []string
GetListHealthChecksVantagePointsSortOrderEnumStringValues Enumerates the set of values in String for ListHealthChecksVantagePointsSortOrderEnum
func GetListHttpMonitorsSortByEnumStringValues() []string
GetListHttpMonitorsSortByEnumStringValues Enumerates the set of values in String for ListHttpMonitorsSortByEnum
func GetListHttpMonitorsSortOrderEnumStringValues() []string
GetListHttpMonitorsSortOrderEnumStringValues Enumerates the set of values in String for ListHttpMonitorsSortOrderEnum
func GetListHttpProbeResultsSortOrderEnumStringValues() []string
GetListHttpProbeResultsSortOrderEnumStringValues Enumerates the set of values in String for ListHttpProbeResultsSortOrderEnum
func GetListPingMonitorsSortByEnumStringValues() []string
GetListPingMonitorsSortByEnumStringValues Enumerates the set of values in String for ListPingMonitorsSortByEnum
func GetListPingMonitorsSortOrderEnumStringValues() []string
GetListPingMonitorsSortOrderEnumStringValues Enumerates the set of values in String for ListPingMonitorsSortOrderEnum
func GetListPingProbeResultsSortOrderEnumStringValues() []string
GetListPingProbeResultsSortOrderEnumStringValues Enumerates the set of values in String for ListPingProbeResultsSortOrderEnum
func GetPingProbeProtocolEnumStringValues() []string
GetPingProbeProtocolEnumStringValues Enumerates the set of values in String for PingProbeProtocolEnum
func GetPingProbeResultSummaryErrorCategoryEnumStringValues() []string
GetPingProbeResultSummaryErrorCategoryEnumStringValues Enumerates the set of values in String for PingProbeResultSummaryErrorCategoryEnum
ChangeHttpMonitorCompartmentDetails The request body used to move a monitor into a compartment.
type ChangeHttpMonitorCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
// into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeHttpMonitorCompartmentDetails) String() string
func (m ChangeHttpMonitorCompartmentDetails) 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
ChangeHttpMonitorCompartmentRequest wrapper for the ChangeHttpMonitorCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ChangeHttpMonitorCompartment.go.html to see an example of how to use ChangeHttpMonitorCompartmentRequest.
type ChangeHttpMonitorCompartmentRequest struct {
// The OCID of a monitor.
MonitorId *string `mandatory:"true" contributesTo:"path" name:"monitorId"`
// The details needed to move the monitor.
ChangeHttpMonitorCompartmentDetails `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 resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request that can be retried in case of a timeout or
// server error without risk of executing the same action again. Retry tokens expire after 24
// hours.
// *Note:* Retry tokens can be invalidated before the 24 hour time limit due to conflicting
// operations, such as a resource being deleted or purged from the system.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeHttpMonitorCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeHttpMonitorCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeHttpMonitorCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeHttpMonitorCompartmentRequest) String() string
func (request ChangeHttpMonitorCompartmentRequest) 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
ChangeHttpMonitorCompartmentResponse wrapper for the ChangeHttpMonitorCompartment operation
type ChangeHttpMonitorCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeHttpMonitorCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeHttpMonitorCompartmentResponse) String() string
ChangePingMonitorCompartmentDetails The request body used to move a monitor into a compartment.
type ChangePingMonitorCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
// into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangePingMonitorCompartmentDetails) String() string
func (m ChangePingMonitorCompartmentDetails) 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
ChangePingMonitorCompartmentRequest wrapper for the ChangePingMonitorCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ChangePingMonitorCompartment.go.html to see an example of how to use ChangePingMonitorCompartmentRequest.
type ChangePingMonitorCompartmentRequest struct {
// The OCID of a monitor.
MonitorId *string `mandatory:"true" contributesTo:"path" name:"monitorId"`
// The details needed to move the monitor.
ChangePingMonitorCompartmentDetails `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 resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request that can be retried in case of a timeout or
// server error without risk of executing the same action again. Retry tokens expire after 24
// hours.
// *Note:* Retry tokens can be invalidated before the 24 hour time limit due to conflicting
// operations, such as a resource being deleted or purged from the system.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangePingMonitorCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangePingMonitorCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangePingMonitorCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangePingMonitorCompartmentRequest) String() string
func (request ChangePingMonitorCompartmentRequest) 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
ChangePingMonitorCompartmentResponse wrapper for the ChangePingMonitorCompartment operation
type ChangePingMonitorCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangePingMonitorCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangePingMonitorCompartmentResponse) String() string
Connection The network connection results.
type Connection struct {
// The connection IP address.
Address *string `mandatory:"false" json:"address"`
// The port.
Port *int `mandatory:"false" json:"port"`
}
func (m Connection) String() string
func (m Connection) 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
CreateHttpMonitorDetails The request body used to create an HTTP monitor.
type CreateHttpMonitorDetails struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A list of targets (hostnames or IP addresses) of the probe.
Targets []string `mandatory:"true" json:"targets"`
Protocol HttpProbeProtocolEnum `mandatory:"true" json:"protocol"`
// A user-friendly and mutable name suitable for display in a user interface.
DisplayName *string `mandatory:"true" json:"displayName"`
// The monitor interval in seconds. Valid values: 10, 30, and 60.
IntervalInSeconds *int `mandatory:"true" json:"intervalInSeconds"`
// A list of names of vantage points from which to execute the probe.
VantagePointNames []string `mandatory:"false" json:"vantagePointNames"`
// The port on which to probe endpoints. If unspecified, probes will use the
// default port of their protocol.
Port *int `mandatory:"false" json:"port"`
// The probe timeout in seconds. Valid values: 10, 20, 30, and 60.
// The probe timeout must be less than or equal to `intervalInSeconds` for monitors.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
Method HttpProbeMethodEnum `mandatory:"false" json:"method,omitempty"`
// The optional URL path to probe, including query parameters.
Path *string `mandatory:"false" json:"path"`
// A dictionary of HTTP request headers.
// *Note:* Monitors and probes do not support the use of the `Authorization` HTTP header.
Headers map[string]string `mandatory:"false" json:"headers"`
// Enables or disables the monitor. Set to 'true' to launch monitoring.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// 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 CreateHttpMonitorDetails) String() string
func (m CreateHttpMonitorDetails) 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
CreateHttpMonitorDetailsMethodEnum is an alias to type: HttpProbeMethodEnum Consider using HttpProbeMethodEnum instead Deprecated
type CreateHttpMonitorDetailsMethodEnum = HttpProbeMethodEnum
CreateHttpMonitorDetailsProtocolEnum is an alias to type: HttpProbeProtocolEnum Consider using HttpProbeProtocolEnum instead Deprecated
type CreateHttpMonitorDetailsProtocolEnum = HttpProbeProtocolEnum
CreateHttpMonitorRequest wrapper for the CreateHttpMonitor operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/CreateHttpMonitor.go.html to see an example of how to use CreateHttpMonitorRequest.
type CreateHttpMonitorRequest struct {
// The configuration details for creating an HTTP monitor.
CreateHttpMonitorDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request that can be retried in case of a timeout or
// server error without risk of executing the same action again. Retry tokens expire after 24
// hours.
// *Note:* Retry tokens can be invalidated before the 24 hour time limit due to conflicting
// operations, such as a resource being deleted or purged from the system.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateHttpMonitorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateHttpMonitorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateHttpMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateHttpMonitorRequest) String() string
func (request CreateHttpMonitorRequest) 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
CreateHttpMonitorResponse wrapper for the CreateHttpMonitor operation
type CreateHttpMonitorResponse struct {
// The underlying http response
RawResponse *http.Response
// The HttpMonitor instance
HttpMonitor `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The URL of the newly created monitor.
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateHttpMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateHttpMonitorResponse) String() string
CreateOnDemandHttpProbeDetails The request body used to create an on-demand HTTP probe.
type CreateOnDemandHttpProbeDetails struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A list of targets (hostnames or IP addresses) of the probe.
Targets []string `mandatory:"true" json:"targets"`
Protocol HttpProbeProtocolEnum `mandatory:"true" json:"protocol"`
// A list of names of vantage points from which to execute the probe.
VantagePointNames []string `mandatory:"false" json:"vantagePointNames"`
// The port on which to probe endpoints. If unspecified, probes will use the
// default port of their protocol.
Port *int `mandatory:"false" json:"port"`
// The probe timeout in seconds. Valid values: 10, 20, 30, and 60.
// The probe timeout must be less than or equal to `intervalInSeconds` for monitors.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
Method HttpProbeMethodEnum `mandatory:"false" json:"method,omitempty"`
// The optional URL path to probe, including query parameters.
Path *string `mandatory:"false" json:"path"`
// A dictionary of HTTP request headers.
// *Note:* Monitors and probes do not support the use of the `Authorization` HTTP header.
Headers map[string]string `mandatory:"false" json:"headers"`
}
func (m CreateOnDemandHttpProbeDetails) String() string
func (m CreateOnDemandHttpProbeDetails) 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
CreateOnDemandHttpProbeDetailsMethodEnum is an alias to type: HttpProbeMethodEnum Consider using HttpProbeMethodEnum instead Deprecated
type CreateOnDemandHttpProbeDetailsMethodEnum = HttpProbeMethodEnum
CreateOnDemandHttpProbeDetailsProtocolEnum is an alias to type: HttpProbeProtocolEnum Consider using HttpProbeProtocolEnum instead Deprecated
type CreateOnDemandHttpProbeDetailsProtocolEnum = HttpProbeProtocolEnum
CreateOnDemandHttpProbeRequest wrapper for the CreateOnDemandHttpProbe operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/CreateOnDemandHttpProbe.go.html to see an example of how to use CreateOnDemandHttpProbeRequest.
type CreateOnDemandHttpProbeRequest struct {
// The configuration of the HTTP probe.
CreateOnDemandHttpProbeDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `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 CreateOnDemandHttpProbeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOnDemandHttpProbeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOnDemandHttpProbeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOnDemandHttpProbeRequest) String() string
func (request CreateOnDemandHttpProbeRequest) 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
CreateOnDemandHttpProbeResponse wrapper for the CreateOnDemandHttpProbe operation
type CreateOnDemandHttpProbeResponse struct {
// The underlying http response
RawResponse *http.Response
// The HttpProbe instance
HttpProbe `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The URL for fetching probe results.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateOnDemandHttpProbeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOnDemandHttpProbeResponse) String() string
CreateOnDemandPingProbeDetails The request body used to create an on-demand ping probe.
type CreateOnDemandPingProbeDetails struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A list of targets (hostnames or IP addresses) of the probe.
Targets []string `mandatory:"true" json:"targets"`
Protocol PingProbeProtocolEnum `mandatory:"true" json:"protocol"`
// A list of names of vantage points from which to execute the probe.
VantagePointNames []string `mandatory:"false" json:"vantagePointNames"`
// The port on which to probe endpoints. If unspecified, probes will use the
// default port of their protocol.
Port *int `mandatory:"false" json:"port"`
// The probe timeout in seconds. Valid values: 10, 20, 30, and 60.
// The probe timeout must be less than or equal to `intervalInSeconds` for monitors.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
}
func (m CreateOnDemandPingProbeDetails) String() string
func (m CreateOnDemandPingProbeDetails) 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
CreateOnDemandPingProbeDetailsProtocolEnum is an alias to type: PingProbeProtocolEnum Consider using PingProbeProtocolEnum instead Deprecated
type CreateOnDemandPingProbeDetailsProtocolEnum = PingProbeProtocolEnum
CreateOnDemandPingProbeRequest wrapper for the CreateOnDemandPingProbe operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/CreateOnDemandPingProbe.go.html to see an example of how to use CreateOnDemandPingProbeRequest.
type CreateOnDemandPingProbeRequest struct {
// Configuration details for creating an on-demand ping probe.
CreateOnDemandPingProbeDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `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 CreateOnDemandPingProbeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOnDemandPingProbeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOnDemandPingProbeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOnDemandPingProbeRequest) String() string
func (request CreateOnDemandPingProbeRequest) 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
CreateOnDemandPingProbeResponse wrapper for the CreateOnDemandPingProbe operation
type CreateOnDemandPingProbeResponse struct {
// The underlying http response
RawResponse *http.Response
// The PingProbe instance
PingProbe `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The URL for fetching probe results.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateOnDemandPingProbeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOnDemandPingProbeResponse) String() string
CreatePingMonitorDetails The request body used to create a Ping monitor.
type CreatePingMonitorDetails struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A list of targets (hostnames or IP addresses) of the probe.
Targets []string `mandatory:"true" json:"targets"`
Protocol PingProbeProtocolEnum `mandatory:"true" json:"protocol"`
// A user-friendly and mutable name suitable for display in a user interface.
DisplayName *string `mandatory:"true" json:"displayName"`
// The monitor interval in seconds. Valid values: 10, 30, and 60.
IntervalInSeconds *int `mandatory:"true" json:"intervalInSeconds"`
// A list of names of vantage points from which to execute the probe.
VantagePointNames []string `mandatory:"false" json:"vantagePointNames"`
// The port on which to probe endpoints. If unspecified, probes will use the
// default port of their protocol.
Port *int `mandatory:"false" json:"port"`
// The probe timeout in seconds. Valid values: 10, 20, 30, and 60.
// The probe timeout must be less than or equal to `intervalInSeconds` for monitors.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
// Enables or disables the monitor. Set to 'true' to launch monitoring.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// 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 CreatePingMonitorDetails) String() string
func (m CreatePingMonitorDetails) 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
CreatePingMonitorDetailsProtocolEnum is an alias to type: PingProbeProtocolEnum Consider using PingProbeProtocolEnum instead Deprecated
type CreatePingMonitorDetailsProtocolEnum = PingProbeProtocolEnum
CreatePingMonitorRequest wrapper for the CreatePingMonitor operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/CreatePingMonitor.go.html to see an example of how to use CreatePingMonitorRequest.
type CreatePingMonitorRequest struct {
// The configuration details for creating a ping monitor.
CreatePingMonitorDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request that can be retried in case of a timeout or
// server error without risk of executing the same action again. Retry tokens expire after 24
// hours.
// *Note:* Retry tokens can be invalidated before the 24 hour time limit due to conflicting
// operations, such as a resource being deleted or purged from the system.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreatePingMonitorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePingMonitorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePingMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePingMonitorRequest) String() string
func (request CreatePingMonitorRequest) 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
CreatePingMonitorResponse wrapper for the CreatePingMonitor operation
type CreatePingMonitorResponse struct {
// The underlying http response
RawResponse *http.Response
// The PingMonitor instance
PingMonitor `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The URL of the newly created monitor.
Location *string `presentIn:"header" name:"location"`
// An entity tag that uniquely identifies a version of the resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreatePingMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePingMonitorResponse) String() string
DeleteHttpMonitorRequest wrapper for the DeleteHttpMonitor operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/DeleteHttpMonitor.go.html to see an example of how to use DeleteHttpMonitorRequest.
type DeleteHttpMonitorRequest struct {
// The OCID of a monitor.
MonitorId *string `mandatory:"true" contributesTo:"path" name:"monitorId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource,
// set the `if-match` parameter to the value of the etag 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 resource's current etag value.
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 DeleteHttpMonitorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteHttpMonitorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteHttpMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteHttpMonitorRequest) String() string
func (request DeleteHttpMonitorRequest) 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
DeleteHttpMonitorResponse wrapper for the DeleteHttpMonitor operation
type DeleteHttpMonitorResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteHttpMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteHttpMonitorResponse) String() string
DeletePingMonitorRequest wrapper for the DeletePingMonitor operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/DeletePingMonitor.go.html to see an example of how to use DeletePingMonitorRequest.
type DeletePingMonitorRequest struct {
// The OCID of a monitor.
MonitorId *string `mandatory:"true" contributesTo:"path" name:"monitorId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource,
// set the `if-match` parameter to the value of the etag 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 resource's current etag value.
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 DeletePingMonitorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePingMonitorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePingMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePingMonitorRequest) String() string
func (request DeletePingMonitorRequest) 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
DeletePingMonitorResponse wrapper for the DeletePingMonitor operation
type DeletePingMonitorResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeletePingMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePingMonitorResponse) String() string
Dns The DNS resolution results.
type Dns struct {
// Total DNS resolution duration, in milliseconds. Calculated using `domainLookupEnd`
// minus `domainLookupStart`.
DomainLookupDuration *float64 `mandatory:"false" json:"domainLookupDuration"`
// The addresses returned by DNS resolution.
Addresses []string `mandatory:"false" json:"addresses"`
}
func (m Dns) String() string
func (m Dns) 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
Geolocation Geographic information about a vantage point.
type Geolocation struct {
// An opaque identifier for the geographic location of the vantage point.
GeoKey *string `mandatory:"false" json:"geoKey"`
// The ISO 3166-2 code for this location's first-level administrative
// division, either a US state or Canadian province. Only included for locations
// in the US or Canada. For a list of codes, see
// Country Codes (https://www.iso.org/obp/ui/#search).
AdminDivCode *string `mandatory:"false" json:"adminDivCode"`
// Common English-language name for the city.
CityName *string `mandatory:"false" json:"cityName"`
// The ISO 3166-1 alpha-2 country code. For a list of codes,
// see Country Codes (https://www.iso.org/obp/ui/#search).
CountryCode *string `mandatory:"false" json:"countryCode"`
// The common English-language name for the country.
CountryName *string `mandatory:"false" json:"countryName"`
// Degrees north of the Equator.
Latitude *float32 `mandatory:"false" json:"latitude"`
// Degrees east of the prime meridian.
Longitude *float32 `mandatory:"false" json:"longitude"`
}
func (m Geolocation) String() string
func (m Geolocation) 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
GetHttpMonitorRequest wrapper for the GetHttpMonitor operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/GetHttpMonitor.go.html to see an example of how to use GetHttpMonitorRequest.
type GetHttpMonitorRequest struct {
// The OCID of a monitor.
MonitorId *string `mandatory:"true" contributesTo:"path" name:"monitorId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The `If-None-Match` header field makes the request method conditional on
// the absence of any current representation of the target resource, when
// the field-value is `*`, or having a selected representation with an
// entity-tag that does not match any of those listed in the field-value.
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 GetHttpMonitorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetHttpMonitorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetHttpMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetHttpMonitorRequest) String() string
func (request GetHttpMonitorRequest) 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
GetHttpMonitorResponse wrapper for the GetHttpMonitor operation
type GetHttpMonitorResponse struct {
// The underlying http response
RawResponse *http.Response
// The HttpMonitor instance
HttpMonitor `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetHttpMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetHttpMonitorResponse) String() string
GetPingMonitorRequest wrapper for the GetPingMonitor operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/GetPingMonitor.go.html to see an example of how to use GetPingMonitorRequest.
type GetPingMonitorRequest struct {
// The OCID of a monitor.
MonitorId *string `mandatory:"true" contributesTo:"path" name:"monitorId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The `If-None-Match` header field makes the request method conditional on
// the absence of any current representation of the target resource, when
// the field-value is `*`, or having a selected representation with an
// entity-tag that does not match any of those listed in the field-value.
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 GetPingMonitorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPingMonitorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPingMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPingMonitorRequest) String() string
func (request GetPingMonitorRequest) 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
GetPingMonitorResponse wrapper for the GetPingMonitor operation
type GetPingMonitorResponse struct {
// The underlying http response
RawResponse *http.Response
// The PingMonitor instance
PingMonitor `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// An entity tag that uniquely identifies a version of the resource.
Etag *string `presentIn:"header" name:"etag"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetPingMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPingMonitorResponse) String() string
HealthChecksClient a client for HealthChecks
type HealthChecksClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewHealthChecksClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client HealthChecksClient, err error)
NewHealthChecksClientWithConfigurationProvider Creates a new default HealthChecks client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewHealthChecksClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client HealthChecksClient, err error)
NewHealthChecksClientWithOboToken Creates a new default HealthChecks 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 HealthChecksClient) ChangeHttpMonitorCompartment(ctx context.Context, request ChangeHttpMonitorCompartmentRequest) (response ChangeHttpMonitorCompartmentResponse, err error)
ChangeHttpMonitorCompartment Moves a monitor into a different compartment. When provided, `If-Match` is checked against ETag values of the resource.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ChangeHttpMonitorCompartment.go.html to see an example of how to use ChangeHttpMonitorCompartment API.
func (client HealthChecksClient) ChangePingMonitorCompartment(ctx context.Context, request ChangePingMonitorCompartmentRequest) (response ChangePingMonitorCompartmentResponse, err error)
ChangePingMonitorCompartment Moves a monitor into a different compartment. When provided, `If-Match` is checked against ETag values of the resource.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ChangePingMonitorCompartment.go.html to see an example of how to use ChangePingMonitorCompartment API.
func (client *HealthChecksClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client HealthChecksClient) CreateHttpMonitor(ctx context.Context, request CreateHttpMonitorRequest) (response CreateHttpMonitorResponse, err error)
CreateHttpMonitor Creates an HTTP monitor. Vantage points will be automatically selected if not specified, and probes will be initiated from each vantage point to each of the targets at the frequency specified by `intervalInSeconds`.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/CreateHttpMonitor.go.html to see an example of how to use CreateHttpMonitor API.
func (client HealthChecksClient) CreateOnDemandHttpProbe(ctx context.Context, request CreateOnDemandHttpProbeRequest) (response CreateOnDemandHttpProbeResponse, err error)
CreateOnDemandHttpProbe Creates an on-demand HTTP probe. The location response header contains the URL for fetching the probe results. *Note:* On-demand probe configurations are not saved.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/CreateOnDemandHttpProbe.go.html to see an example of how to use CreateOnDemandHttpProbe API.
func (client HealthChecksClient) CreateOnDemandPingProbe(ctx context.Context, request CreateOnDemandPingProbeRequest) (response CreateOnDemandPingProbeResponse, err error)
CreateOnDemandPingProbe Creates an on-demand ping probe. The location response header contains the URL for fetching probe results. *Note:* The on-demand probe configuration is not saved.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/CreateOnDemandPingProbe.go.html to see an example of how to use CreateOnDemandPingProbe API.
func (client HealthChecksClient) CreatePingMonitor(ctx context.Context, request CreatePingMonitorRequest) (response CreatePingMonitorResponse, err error)
CreatePingMonitor Creates a ping monitor. Vantage points will be automatically selected if not specified, and probes will be initiated from each vantage point to each of the targets at the frequency specified by `intervalInSeconds`.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/CreatePingMonitor.go.html to see an example of how to use CreatePingMonitor API.
func (client HealthChecksClient) DeleteHttpMonitor(ctx context.Context, request DeleteHttpMonitorRequest) (response DeleteHttpMonitorResponse, err error)
DeleteHttpMonitor Deletes the HTTP monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/DeleteHttpMonitor.go.html to see an example of how to use DeleteHttpMonitor API.
func (client HealthChecksClient) DeletePingMonitor(ctx context.Context, request DeletePingMonitorRequest) (response DeletePingMonitorResponse, err error)
DeletePingMonitor Deletes the ping monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/DeletePingMonitor.go.html to see an example of how to use DeletePingMonitor API.
func (client HealthChecksClient) GetHttpMonitor(ctx context.Context, request GetHttpMonitorRequest) (response GetHttpMonitorResponse, err error)
GetHttpMonitor Gets the configuration for the specified monitor.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/GetHttpMonitor.go.html to see an example of how to use GetHttpMonitor API.
func (client HealthChecksClient) GetPingMonitor(ctx context.Context, request GetPingMonitorRequest) (response GetPingMonitorResponse, err error)
GetPingMonitor Gets the configuration for the specified ping monitor.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/GetPingMonitor.go.html to see an example of how to use GetPingMonitor API.
func (client HealthChecksClient) ListHealthChecksVantagePoints(ctx context.Context, request ListHealthChecksVantagePointsRequest) (response ListHealthChecksVantagePointsResponse, err error)
ListHealthChecksVantagePoints Gets information about all vantage points available to the user.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ListHealthChecksVantagePoints.go.html to see an example of how to use ListHealthChecksVantagePoints API.
func (client HealthChecksClient) ListHttpMonitors(ctx context.Context, request ListHttpMonitorsRequest) (response ListHttpMonitorsResponse, err error)
ListHttpMonitors Gets a list of HTTP monitors.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ListHttpMonitors.go.html to see an example of how to use ListHttpMonitors API.
func (client HealthChecksClient) ListHttpProbeResults(ctx context.Context, request ListHttpProbeResultsRequest) (response ListHttpProbeResultsResponse, err error)
ListHttpProbeResults Gets the HTTP probe results for the specified probe or monitor, where the `probeConfigurationId` is the OCID of either a monitor or an on-demand probe.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ListHttpProbeResults.go.html to see an example of how to use ListHttpProbeResults API.
func (client HealthChecksClient) ListPingMonitors(ctx context.Context, request ListPingMonitorsRequest) (response ListPingMonitorsResponse, err error)
ListPingMonitors Gets a list of configured ping monitors. Results are paginated based on `page` and `limit`. The `opc-next-page` header provides a URL for fetching the next page.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ListPingMonitors.go.html to see an example of how to use ListPingMonitors API.
func (client HealthChecksClient) ListPingProbeResults(ctx context.Context, request ListPingProbeResultsRequest) (response ListPingProbeResultsResponse, err error)
ListPingProbeResults Returns the results for the specified probe, where the `probeConfigurationId` is the OCID of either a monitor or an on-demand probe. Results are paginated based on `page` and `limit`. The `opc-next-page` header provides a URL for fetching the next page. Use `sortOrder` to set the order of the results. If `sortOrder` is unspecified, results are sorted in ascending order by `startTime`.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ListPingProbeResults.go.html to see an example of how to use ListPingProbeResults API.
func (client *HealthChecksClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client HealthChecksClient) UpdateHttpMonitor(ctx context.Context, request UpdateHttpMonitorRequest) (response UpdateHttpMonitorResponse, err error)
UpdateHttpMonitor Updates the configuration of the specified HTTP monitor. Only the fields specified in the request body will be updated; all other configuration properties will remain unchanged.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/UpdateHttpMonitor.go.html to see an example of how to use UpdateHttpMonitor API.
func (client HealthChecksClient) UpdatePingMonitor(ctx context.Context, request UpdatePingMonitorRequest) (response UpdatePingMonitorResponse, err error)
UpdatePingMonitor Updates the configuration of the specified ping monitor. Only the fields specified in the request body will be updated; all other configuration properties will remain unchanged.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/UpdatePingMonitor.go.html to see an example of how to use UpdatePingMonitor API.
HealthChecksVantagePointSummary Information about a vantage point.
type HealthChecksVantagePointSummary struct {
// The display name for the vantage point. Display names are determined by
// the best information available and may change over time.
DisplayName *string `mandatory:"false" json:"displayName"`
// The organization on whose infrastructure this vantage point resides.
// Provider names are not unique, as Oracle Cloud Infrastructure maintains
// many vantage points in each major provider.
ProviderName *string `mandatory:"false" json:"providerName"`
// The unique, permanent name for the vantage point.
Name *string `mandatory:"false" json:"name"`
Geo *Geolocation `mandatory:"false" json:"geo"`
// An array of objects that describe how traffic to this vantage point is
// routed, including which prefixes and ASNs connect it to the internet.
// The addresses are sorted from the most-specific to least-specific
// prefix (the smallest network to largest network). When a prefix has
// multiple origin ASNs (MOAS routing), they are sorted by weight
// (highest to lowest). Weight is determined by the total percentage of
// peers observing the prefix originating from an ASN. Only present if
// `fields` includes `routing`. The field will be null if the address's
// routing information is unknown.
Routing []Routing `mandatory:"false" json:"routing"`
}
func (m HealthChecksVantagePointSummary) String() string
func (m HealthChecksVantagePointSummary) 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
HttpMonitor This model contains all of the mutable and immutable properties for an HTTP monitor.
type HttpMonitor struct {
// The OCID of the resource.
Id *string `mandatory:"false" json:"id"`
// A URL for fetching the probe results.
ResultsUrl *string `mandatory:"false" json:"resultsUrl"`
// The region where updates must be made and where results must be fetched from.
HomeRegion *string `mandatory:"false" json:"homeRegion"`
// The RFC 3339-formatted creation date and time of the probe.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// A list of targets (hostnames or IP addresses) of the probe.
Targets []string `mandatory:"false" json:"targets"`
// A list of names of vantage points from which to execute the probe.
VantagePointNames []string `mandatory:"false" json:"vantagePointNames"`
// The port on which to probe endpoints. If unspecified, probes will use the
// default port of their protocol.
Port *int `mandatory:"false" json:"port"`
// The probe timeout in seconds. Valid values: 10, 20, 30, and 60.
// The probe timeout must be less than or equal to `intervalInSeconds` for monitors.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
Protocol HttpProbeProtocolEnum `mandatory:"false" json:"protocol,omitempty"`
Method HttpProbeMethodEnum `mandatory:"false" json:"method,omitempty"`
// The optional URL path to probe, including query parameters.
Path *string `mandatory:"false" json:"path"`
// A dictionary of HTTP request headers.
// *Note:* Monitors and probes do not support the use of the `Authorization` HTTP header.
Headers map[string]string `mandatory:"false" json:"headers"`
// A user-friendly and mutable name suitable for display in a user interface.
DisplayName *string `mandatory:"false" json:"displayName"`
// The monitor interval in seconds. Valid values: 10, 30, and 60.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Enables or disables the monitor. Set to 'true' to launch monitoring.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// 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 HttpMonitor) String() string
func (m HttpMonitor) 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
HttpMonitorMethodEnum is an alias to type: HttpProbeMethodEnum Consider using HttpProbeMethodEnum instead Deprecated
type HttpMonitorMethodEnum = HttpProbeMethodEnum
HttpMonitorProtocolEnum is an alias to type: HttpProbeProtocolEnum Consider using HttpProbeProtocolEnum instead Deprecated
type HttpMonitorProtocolEnum = HttpProbeProtocolEnum
HttpMonitorSummary A summary containing all of the mutable and immutable properties for an HTTP monitor.
type HttpMonitorSummary struct {
// The OCID of the resource.
Id *string `mandatory:"false" json:"id"`
// A URL for fetching the probe results.
ResultsUrl *string `mandatory:"false" json:"resultsUrl"`
// The region where updates must be made and where results must be fetched from.
HomeRegion *string `mandatory:"false" json:"homeRegion"`
// The RFC 3339-formatted creation date and time of the probe.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// A user-friendly and mutable name suitable for display in a user interface.
DisplayName *string `mandatory:"false" json:"displayName"`
// The monitor interval in seconds. Valid values: 10, 30, and 60.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Enables or disables the monitor. Set to 'true' to launch monitoring.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// 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"`
Protocol HttpProbeProtocolEnum `mandatory:"false" json:"protocol,omitempty"`
}
func (m HttpMonitorSummary) String() string
func (m HttpMonitorSummary) 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
HttpMonitorSummaryProtocolEnum is an alias to type: HttpProbeProtocolEnum Consider using HttpProbeProtocolEnum instead Deprecated
type HttpMonitorSummaryProtocolEnum = HttpProbeProtocolEnum
HttpProbe A summary that contains all of the mutable and immutable properties for an HTTP probe.
type HttpProbe struct {
// The OCID of the resource.
Id *string `mandatory:"false" json:"id"`
// A URL for fetching the probe results.
ResultsUrl *string `mandatory:"false" json:"resultsUrl"`
// The region where updates must be made and where results must be fetched from.
HomeRegion *string `mandatory:"false" json:"homeRegion"`
// The RFC 3339-formatted creation date and time of the probe.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// A list of targets (hostnames or IP addresses) of the probe.
Targets []string `mandatory:"false" json:"targets"`
// A list of names of vantage points from which to execute the probe.
VantagePointNames []string `mandatory:"false" json:"vantagePointNames"`
// The port on which to probe endpoints. If unspecified, probes will use the
// default port of their protocol.
Port *int `mandatory:"false" json:"port"`
// The probe timeout in seconds. Valid values: 10, 20, 30, and 60.
// The probe timeout must be less than or equal to `intervalInSeconds` for monitors.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
Protocol HttpProbeProtocolEnum `mandatory:"false" json:"protocol,omitempty"`
Method HttpProbeMethodEnum `mandatory:"false" json:"method,omitempty"`
// The optional URL path to probe, including query parameters.
Path *string `mandatory:"false" json:"path"`
// A dictionary of HTTP request headers.
// *Note:* Monitors and probes do not support the use of the `Authorization` HTTP header.
Headers map[string]string `mandatory:"false" json:"headers"`
}
func (m HttpProbe) String() string
func (m HttpProbe) 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
HttpProbeMethodEnum Enum with underlying type: string
type HttpProbeMethodEnum string
Set of constants representing the allowable values for HttpProbeMethodEnum Deprecated
const (
CreateHttpMonitorDetailsMethodGet HttpProbeMethodEnum = "GET"
CreateHttpMonitorDetailsMethodHead HttpProbeMethodEnum = "HEAD"
)
Set of constants representing the allowable values for HttpProbeMethodEnum Deprecated
const (
CreateOnDemandHttpProbeDetailsMethodGet HttpProbeMethodEnum = "GET"
CreateOnDemandHttpProbeDetailsMethodHead HttpProbeMethodEnum = "HEAD"
)
Set of constants representing the allowable values for HttpProbeMethodEnum Deprecated
const (
HttpMonitorMethodGet HttpProbeMethodEnum = "GET"
HttpMonitorMethodHead HttpProbeMethodEnum = "HEAD"
)
Set of constants representing the allowable values for HttpProbeMethodEnum
const (
HttpProbeMethodGet HttpProbeMethodEnum = "GET"
HttpProbeMethodHead HttpProbeMethodEnum = "HEAD"
)
Set of constants representing the allowable values for HttpProbeMethodEnum Deprecated
const (
UpdateHttpMonitorDetailsMethodGet HttpProbeMethodEnum = "GET"
UpdateHttpMonitorDetailsMethodHead HttpProbeMethodEnum = "HEAD"
)
func GetHttpProbeMethodEnumValues() []HttpProbeMethodEnum
GetHttpProbeMethodEnumValues Enumerates the set of values for HttpProbeMethodEnum
func GetMappingHttpProbeMethodEnum(val string) (HttpProbeMethodEnum, bool)
GetMappingHttpProbeMethodEnum performs case Insensitive comparison on enum value and return the desired enum
HttpProbeProtocolEnum Enum with underlying type: string
type HttpProbeProtocolEnum string
Set of constants representing the allowable values for HttpProbeProtocolEnum Deprecated
const (
CreateHttpMonitorDetailsProtocolHttp HttpProbeProtocolEnum = "HTTP"
CreateHttpMonitorDetailsProtocolHttps HttpProbeProtocolEnum = "HTTPS"
)
Set of constants representing the allowable values for HttpProbeProtocolEnum Deprecated
const (
CreateOnDemandHttpProbeDetailsProtocolHttp HttpProbeProtocolEnum = "HTTP"
CreateOnDemandHttpProbeDetailsProtocolHttps HttpProbeProtocolEnum = "HTTPS"
)
Set of constants representing the allowable values for HttpProbeProtocolEnum Deprecated
const (
HttpMonitorProtocolHttp HttpProbeProtocolEnum = "HTTP"
HttpMonitorProtocolHttps HttpProbeProtocolEnum = "HTTPS"
)
Set of constants representing the allowable values for HttpProbeProtocolEnum Deprecated
const (
HttpMonitorSummaryProtocolHttp HttpProbeProtocolEnum = "HTTP"
HttpMonitorSummaryProtocolHttps HttpProbeProtocolEnum = "HTTPS"
)
Set of constants representing the allowable values for HttpProbeProtocolEnum
const (
HttpProbeProtocolHttp HttpProbeProtocolEnum = "HTTP"
HttpProbeProtocolHttps HttpProbeProtocolEnum = "HTTPS"
)
Set of constants representing the allowable values for HttpProbeProtocolEnum Deprecated
const (
HttpProbeResultSummaryProtocolHttp HttpProbeProtocolEnum = "HTTP"
HttpProbeResultSummaryProtocolHttps HttpProbeProtocolEnum = "HTTPS"
)
Set of constants representing the allowable values for HttpProbeProtocolEnum Deprecated
const (
UpdateHttpMonitorDetailsProtocolHttp HttpProbeProtocolEnum = "HTTP"
UpdateHttpMonitorDetailsProtocolHttps HttpProbeProtocolEnum = "HTTPS"
)
func GetHttpProbeProtocolEnumValues() []HttpProbeProtocolEnum
GetHttpProbeProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum
func GetMappingHttpProbeProtocolEnum(val string) (HttpProbeProtocolEnum, bool)
GetMappingHttpProbeProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
HttpProbeResultSummary The results returned by running an HTTP probe. All times and durations are returned in milliseconds. All times are relative to the POSIX epoch (1970-01-01T00:00Z). Time properties conform to W3C Resource Timing. For more information, see PerformanceResourceTiming (https://w3c.github.io/resource-timing/#sec-resource-timing) interface.
type HttpProbeResultSummary struct {
// A value identifying this specific probe result. The key is only unique within
// the results of its probe configuration. The key may be reused after 90 days.
Key *string `mandatory:"false" json:"key"`
// The OCID of the monitor or on-demand probe responsible for creating this result.
ProbeConfigurationId *string `mandatory:"false" json:"probeConfigurationId"`
// The date and time the probe was executed, expressed in milliseconds since the
// POSIX epoch. This field is defined by the PerformanceResourceTiming interface
// of the W3C Resource Timing specification. For more information, see
// Resource Timing (https://w3c.github.io/resource-timing/#sec-resource-timing).
StartTime *float64 `mandatory:"false" json:"startTime"`
// The target hostname or IP address of the probe.
Target *string `mandatory:"false" json:"target"`
// The name of the vantage point that executed the probe.
VantagePointName *string `mandatory:"false" json:"vantagePointName"`
// True if the probe did not complete before the configured `timeoutInSeconds` value.
IsTimedOut *bool `mandatory:"false" json:"isTimedOut"`
// True if the probe result is determined to be healthy based on probe
// type-specific criteria. For HTTP probes, a probe result is considered
// healthy if the HTTP response code is greater than or equal to 200 and
// less than 300.
IsHealthy *bool `mandatory:"false" json:"isHealthy"`
// The category of error if an error occurs executing the probe.
// The `errorMessage` field provides a message with the error details.
// * NONE - No error
// * DNS - DNS errors
// * TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error.
// * NETWORK - Network-related errors, for example a "network unreachable" error.
// * SYSTEM - Internal system errors.
ErrorCategory HttpProbeResultSummaryErrorCategoryEnum `mandatory:"false" json:"errorCategory,omitempty"`
// The error information indicating why a probe execution failed.
ErrorMessage *string `mandatory:"false" json:"errorMessage"`
Protocol HttpProbeProtocolEnum `mandatory:"false" json:"protocol,omitempty"`
Connection *TcpConnection `mandatory:"false" json:"connection"`
Dns *Dns `mandatory:"false" json:"dns"`
// The HTTP response status code.
StatusCode *int `mandatory:"false" json:"statusCode"`
// The time immediately before the vantage point starts the domain name lookup for
// the resource.
DomainLookupStart *float64 `mandatory:"false" json:"domainLookupStart"`
// The time immediately before the vantage point finishes the domain name lookup for
// the resource.
DomainLookupEnd *float64 `mandatory:"false" json:"domainLookupEnd"`
// The time immediately before the vantage point starts establishing the connection
// to the server to retrieve the resource.
ConnectStart *float64 `mandatory:"false" json:"connectStart"`
// The time immediately before the vantage point starts the handshake process to
// secure the current connection.
SecureConnectionStart *float64 `mandatory:"false" json:"secureConnectionStart"`
// The time immediately after the vantage point finishes establishing the connection
// to the server to retrieve the resource.
ConnectEnd *float64 `mandatory:"false" json:"connectEnd"`
// The time immediately before the vantage point starts to fetch the resource.
FetchStart *float64 `mandatory:"false" json:"fetchStart"`
// The time immediately before the vantage point starts requesting the resource from
// the server.
RequestStart *float64 `mandatory:"false" json:"requestStart"`
// The time immediately after the vantage point's HTTP parser receives the first byte
// of the response.
ResponseStart *float64 `mandatory:"false" json:"responseStart"`
// The time immediately after the vantage point receives the last byte of the response
// or immediately before the transport connection is closed, whichever comes first.
ResponseEnd *float64 `mandatory:"false" json:"responseEnd"`
// The total duration from start of request until response is fully consumed or the
// connection is closed.
Duration *float64 `mandatory:"false" json:"duration"`
// The size, in octets, of the payload body prior to removing any applied
// content-codings.
EncodedBodySize *int `mandatory:"false" json:"encodedBodySize"`
}
func (m HttpProbeResultSummary) String() string
func (m HttpProbeResultSummary) 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
HttpProbeResultSummaryErrorCategoryEnum Enum with underlying type: string
type HttpProbeResultSummaryErrorCategoryEnum string
Set of constants representing the allowable values for HttpProbeResultSummaryErrorCategoryEnum
const (
HttpProbeResultSummaryErrorCategoryNone HttpProbeResultSummaryErrorCategoryEnum = "NONE"
HttpProbeResultSummaryErrorCategoryDns HttpProbeResultSummaryErrorCategoryEnum = "DNS"
HttpProbeResultSummaryErrorCategoryTransport HttpProbeResultSummaryErrorCategoryEnum = "TRANSPORT"
HttpProbeResultSummaryErrorCategoryNetwork HttpProbeResultSummaryErrorCategoryEnum = "NETWORK"
HttpProbeResultSummaryErrorCategorySystem HttpProbeResultSummaryErrorCategoryEnum = "SYSTEM"
)
func GetHttpProbeResultSummaryErrorCategoryEnumValues() []HttpProbeResultSummaryErrorCategoryEnum
GetHttpProbeResultSummaryErrorCategoryEnumValues Enumerates the set of values for HttpProbeResultSummaryErrorCategoryEnum
func GetMappingHttpProbeResultSummaryErrorCategoryEnum(val string) (HttpProbeResultSummaryErrorCategoryEnum, bool)
GetMappingHttpProbeResultSummaryErrorCategoryEnum performs case Insensitive comparison on enum value and return the desired enum
HttpProbeResultSummaryProtocolEnum is an alias to type: HttpProbeProtocolEnum Consider using HttpProbeProtocolEnum instead Deprecated
type HttpProbeResultSummaryProtocolEnum = HttpProbeProtocolEnum
ListHealthChecksVantagePointsRequest wrapper for the ListHealthChecksVantagePoints operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ListHealthChecksVantagePoints.go.html to see an example of how to use ListHealthChecksVantagePointsRequest.
type ListHealthChecksVantagePointsRequest struct {
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header
// from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The field to sort by when listing vantage points.
SortBy ListHealthChecksVantagePointsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Controls the sort order of results.
SortOrder ListHealthChecksVantagePointsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Filters results that exactly match the `name` field.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// Filters results that exactly match the `displayName` field.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// 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 ListHealthChecksVantagePointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListHealthChecksVantagePointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListHealthChecksVantagePointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListHealthChecksVantagePointsRequest) String() string
func (request ListHealthChecksVantagePointsRequest) 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
ListHealthChecksVantagePointsResponse wrapper for the ListHealthChecksVantagePoints operation
type ListHealthChecksVantagePointsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []HealthChecksVantagePointSummary instances
Items []HealthChecksVantagePointSummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if
// this header appears in the response, then there may be additional
// items still to get. Include this value as the `page` parameter for the
// subsequent GET request. For information about pagination, see
// List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#List_Pagination).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListHealthChecksVantagePointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListHealthChecksVantagePointsResponse) String() string
ListHealthChecksVantagePointsSortByEnum Enum with underlying type: string
type ListHealthChecksVantagePointsSortByEnum string
Set of constants representing the allowable values for ListHealthChecksVantagePointsSortByEnum
const (
ListHealthChecksVantagePointsSortByName ListHealthChecksVantagePointsSortByEnum = "name"
ListHealthChecksVantagePointsSortByDisplayname ListHealthChecksVantagePointsSortByEnum = "displayName"
)
func GetListHealthChecksVantagePointsSortByEnumValues() []ListHealthChecksVantagePointsSortByEnum
GetListHealthChecksVantagePointsSortByEnumValues Enumerates the set of values for ListHealthChecksVantagePointsSortByEnum
func GetMappingListHealthChecksVantagePointsSortByEnum(val string) (ListHealthChecksVantagePointsSortByEnum, bool)
GetMappingListHealthChecksVantagePointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListHealthChecksVantagePointsSortOrderEnum Enum with underlying type: string
type ListHealthChecksVantagePointsSortOrderEnum string
Set of constants representing the allowable values for ListHealthChecksVantagePointsSortOrderEnum
const (
ListHealthChecksVantagePointsSortOrderAsc ListHealthChecksVantagePointsSortOrderEnum = "ASC"
ListHealthChecksVantagePointsSortOrderDesc ListHealthChecksVantagePointsSortOrderEnum = "DESC"
)
func GetListHealthChecksVantagePointsSortOrderEnumValues() []ListHealthChecksVantagePointsSortOrderEnum
GetListHealthChecksVantagePointsSortOrderEnumValues Enumerates the set of values for ListHealthChecksVantagePointsSortOrderEnum
func GetMappingListHealthChecksVantagePointsSortOrderEnum(val string) (ListHealthChecksVantagePointsSortOrderEnum, bool)
GetMappingListHealthChecksVantagePointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListHttpMonitorsRequest wrapper for the ListHttpMonitors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ListHttpMonitors.go.html to see an example of how to use ListHttpMonitorsRequest.
type ListHttpMonitorsRequest struct {
// Filters results by compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header
// from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The field to sort by when listing monitors.
SortBy ListHttpMonitorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Controls the sort order of results.
SortOrder ListHttpMonitorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Filters results that exactly match the `displayName` field.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filters results that match the `homeRegion`.
HomeRegion *string `mandatory:"false" contributesTo:"query" name:"homeRegion"`
// 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 ListHttpMonitorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListHttpMonitorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListHttpMonitorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListHttpMonitorsRequest) String() string
func (request ListHttpMonitorsRequest) 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
ListHttpMonitorsResponse wrapper for the ListHttpMonitors operation
type ListHttpMonitorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []HttpMonitorSummary instances
Items []HttpMonitorSummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For 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 ListHttpMonitorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListHttpMonitorsResponse) String() string
ListHttpMonitorsSortByEnum Enum with underlying type: string
type ListHttpMonitorsSortByEnum string
Set of constants representing the allowable values for ListHttpMonitorsSortByEnum
const (
ListHttpMonitorsSortById ListHttpMonitorsSortByEnum = "id"
ListHttpMonitorsSortByDisplayname ListHttpMonitorsSortByEnum = "displayName"
ListHttpMonitorsSortByTimecreated ListHttpMonitorsSortByEnum = "timeCreated"
)
func GetListHttpMonitorsSortByEnumValues() []ListHttpMonitorsSortByEnum
GetListHttpMonitorsSortByEnumValues Enumerates the set of values for ListHttpMonitorsSortByEnum
func GetMappingListHttpMonitorsSortByEnum(val string) (ListHttpMonitorsSortByEnum, bool)
GetMappingListHttpMonitorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListHttpMonitorsSortOrderEnum Enum with underlying type: string
type ListHttpMonitorsSortOrderEnum string
Set of constants representing the allowable values for ListHttpMonitorsSortOrderEnum
const (
ListHttpMonitorsSortOrderAsc ListHttpMonitorsSortOrderEnum = "ASC"
ListHttpMonitorsSortOrderDesc ListHttpMonitorsSortOrderEnum = "DESC"
)
func GetListHttpMonitorsSortOrderEnumValues() []ListHttpMonitorsSortOrderEnum
GetListHttpMonitorsSortOrderEnumValues Enumerates the set of values for ListHttpMonitorsSortOrderEnum
func GetMappingListHttpMonitorsSortOrderEnum(val string) (ListHttpMonitorsSortOrderEnum, bool)
GetMappingListHttpMonitorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListHttpProbeResultsRequest wrapper for the ListHttpProbeResults operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ListHttpProbeResults.go.html to see an example of how to use ListHttpProbeResultsRequest.
type ListHttpProbeResultsRequest struct {
// The OCID of a monitor or on-demand probe.
ProbeConfigurationId *string `mandatory:"true" contributesTo:"path" name:"probeConfigurationId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header
// from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Returns results with a `startTime` equal to or greater than the specified value.
StartTimeGreaterThanOrEqualTo *float64 `mandatory:"false" contributesTo:"query" name:"startTimeGreaterThanOrEqualTo"`
// Returns results with a `startTime` equal to or less than the specified value.
StartTimeLessThanOrEqualTo *float64 `mandatory:"false" contributesTo:"query" name:"startTimeLessThanOrEqualTo"`
// Controls the sort order of results.
SortOrder ListHttpProbeResultsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Filters results that match the `target`.
Target *string `mandatory:"false" contributesTo:"query" name:"target"`
// 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 ListHttpProbeResultsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListHttpProbeResultsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListHttpProbeResultsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListHttpProbeResultsRequest) String() string
func (request ListHttpProbeResultsRequest) 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
ListHttpProbeResultsResponse wrapper for the ListHttpProbeResults operation
type ListHttpProbeResultsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []HttpProbeResultSummary instances
Items []HttpProbeResultSummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For 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 ListHttpProbeResultsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListHttpProbeResultsResponse) String() string
ListHttpProbeResultsSortOrderEnum Enum with underlying type: string
type ListHttpProbeResultsSortOrderEnum string
Set of constants representing the allowable values for ListHttpProbeResultsSortOrderEnum
const (
ListHttpProbeResultsSortOrderAsc ListHttpProbeResultsSortOrderEnum = "ASC"
ListHttpProbeResultsSortOrderDesc ListHttpProbeResultsSortOrderEnum = "DESC"
)
func GetListHttpProbeResultsSortOrderEnumValues() []ListHttpProbeResultsSortOrderEnum
GetListHttpProbeResultsSortOrderEnumValues Enumerates the set of values for ListHttpProbeResultsSortOrderEnum
func GetMappingListHttpProbeResultsSortOrderEnum(val string) (ListHttpProbeResultsSortOrderEnum, bool)
GetMappingListHttpProbeResultsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPingMonitorsRequest wrapper for the ListPingMonitors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ListPingMonitors.go.html to see an example of how to use ListPingMonitorsRequest.
type ListPingMonitorsRequest struct {
// Filters results by compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header
// from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The field to sort by when listing monitors.
SortBy ListPingMonitorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Controls the sort order of results.
SortOrder ListPingMonitorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Filters results that exactly match the `displayName` field.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filters results that match the `homeRegion`.
HomeRegion *string `mandatory:"false" contributesTo:"query" name:"homeRegion"`
// 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 ListPingMonitorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPingMonitorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPingMonitorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPingMonitorsRequest) String() string
func (request ListPingMonitorsRequest) 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
ListPingMonitorsResponse wrapper for the ListPingMonitors operation
type ListPingMonitorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []PingMonitorSummary instances
Items []PingMonitorSummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For 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 ListPingMonitorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPingMonitorsResponse) String() string
ListPingMonitorsSortByEnum Enum with underlying type: string
type ListPingMonitorsSortByEnum string
Set of constants representing the allowable values for ListPingMonitorsSortByEnum
const (
ListPingMonitorsSortById ListPingMonitorsSortByEnum = "id"
ListPingMonitorsSortByDisplayname ListPingMonitorsSortByEnum = "displayName"
ListPingMonitorsSortByTimecreated ListPingMonitorsSortByEnum = "timeCreated"
)
func GetListPingMonitorsSortByEnumValues() []ListPingMonitorsSortByEnum
GetListPingMonitorsSortByEnumValues Enumerates the set of values for ListPingMonitorsSortByEnum
func GetMappingListPingMonitorsSortByEnum(val string) (ListPingMonitorsSortByEnum, bool)
GetMappingListPingMonitorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPingMonitorsSortOrderEnum Enum with underlying type: string
type ListPingMonitorsSortOrderEnum string
Set of constants representing the allowable values for ListPingMonitorsSortOrderEnum
const (
ListPingMonitorsSortOrderAsc ListPingMonitorsSortOrderEnum = "ASC"
ListPingMonitorsSortOrderDesc ListPingMonitorsSortOrderEnum = "DESC"
)
func GetListPingMonitorsSortOrderEnumValues() []ListPingMonitorsSortOrderEnum
GetListPingMonitorsSortOrderEnumValues Enumerates the set of values for ListPingMonitorsSortOrderEnum
func GetMappingListPingMonitorsSortOrderEnum(val string) (ListPingMonitorsSortOrderEnum, bool)
GetMappingListPingMonitorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPingProbeResultsRequest wrapper for the ListPingProbeResults operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/ListPingProbeResults.go.html to see an example of how to use ListPingProbeResultsRequest.
type ListPingProbeResultsRequest struct {
// The OCID of a monitor or on-demand probe.
ProbeConfigurationId *string `mandatory:"true" contributesTo:"path" name:"probeConfigurationId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header
// from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Returns results with a `startTime` equal to or greater than the specified value.
StartTimeGreaterThanOrEqualTo *float64 `mandatory:"false" contributesTo:"query" name:"startTimeGreaterThanOrEqualTo"`
// Returns results with a `startTime` equal to or less than the specified value.
StartTimeLessThanOrEqualTo *float64 `mandatory:"false" contributesTo:"query" name:"startTimeLessThanOrEqualTo"`
// Controls the sort order of results.
SortOrder ListPingProbeResultsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Filters results that match the `target`.
Target *string `mandatory:"false" contributesTo:"query" name:"target"`
// 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 ListPingProbeResultsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPingProbeResultsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPingProbeResultsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPingProbeResultsRequest) String() string
func (request ListPingProbeResultsRequest) 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
ListPingProbeResultsResponse wrapper for the ListPingProbeResults operation
type ListPingProbeResultsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []PingProbeResultSummary instances
Items []PingProbeResultSummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list,
// if this header appears in the response, then there may be
// additional items still to get. Include this value as the `page`
// parameter for the subsequent GET request. For information about
// pagination, see
// List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#List_Pagination).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListPingProbeResultsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPingProbeResultsResponse) String() string
ListPingProbeResultsSortOrderEnum Enum with underlying type: string
type ListPingProbeResultsSortOrderEnum string
Set of constants representing the allowable values for ListPingProbeResultsSortOrderEnum
const (
ListPingProbeResultsSortOrderAsc ListPingProbeResultsSortOrderEnum = "ASC"
ListPingProbeResultsSortOrderDesc ListPingProbeResultsSortOrderEnum = "DESC"
)
func GetListPingProbeResultsSortOrderEnumValues() []ListPingProbeResultsSortOrderEnum
GetListPingProbeResultsSortOrderEnumValues Enumerates the set of values for ListPingProbeResultsSortOrderEnum
func GetMappingListPingProbeResultsSortOrderEnum(val string) (ListPingProbeResultsSortOrderEnum, bool)
GetMappingListPingProbeResultsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
PingMonitor A summary containing all of the mutable and immutable properties for a ping monitor.
type PingMonitor struct {
// The OCID of the resource.
Id *string `mandatory:"false" json:"id"`
// A URL for fetching the probe results.
ResultsUrl *string `mandatory:"false" json:"resultsUrl"`
// The region where updates must be made and where results must be fetched from.
HomeRegion *string `mandatory:"false" json:"homeRegion"`
// The RFC 3339-formatted creation date and time of the probe.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// A list of targets (hostnames or IP addresses) of the probe.
Targets []string `mandatory:"false" json:"targets"`
// A list of names of vantage points from which to execute the probe.
VantagePointNames []string `mandatory:"false" json:"vantagePointNames"`
// The port on which to probe endpoints. If unspecified, probes will use the
// default port of their protocol.
Port *int `mandatory:"false" json:"port"`
// The probe timeout in seconds. Valid values: 10, 20, 30, and 60.
// The probe timeout must be less than or equal to `intervalInSeconds` for monitors.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
Protocol PingProbeProtocolEnum `mandatory:"false" json:"protocol,omitempty"`
// A user-friendly and mutable name suitable for display in a user interface.
DisplayName *string `mandatory:"false" json:"displayName"`
// The monitor interval in seconds. Valid values: 10, 30, and 60.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Enables or disables the monitor. Set to 'true' to launch monitoring.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// 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 PingMonitor) String() string
func (m PingMonitor) 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
PingMonitorProtocolEnum is an alias to type: PingProbeProtocolEnum Consider using PingProbeProtocolEnum instead Deprecated
type PingMonitorProtocolEnum = PingProbeProtocolEnum
PingMonitorSummary This model contains all of the mutable and immutable summary properties for an HTTP monitor.
type PingMonitorSummary struct {
// The OCID of the resource.
Id *string `mandatory:"false" json:"id"`
// A URL for fetching the probe results.
ResultsUrl *string `mandatory:"false" json:"resultsUrl"`
// The region where updates must be made and where results must be fetched from.
HomeRegion *string `mandatory:"false" json:"homeRegion"`
// The RFC 3339-formatted creation date and time of the probe.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// A user-friendly and mutable name suitable for display in a user interface.
DisplayName *string `mandatory:"false" json:"displayName"`
// The monitor interval in seconds. Valid values: 10, 30, and 60.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Enables or disables the monitor. Set to 'true' to launch monitoring.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// 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"`
Protocol PingProbeProtocolEnum `mandatory:"false" json:"protocol,omitempty"`
}
func (m PingMonitorSummary) String() string
func (m PingMonitorSummary) 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
PingMonitorSummaryProtocolEnum is an alias to type: PingProbeProtocolEnum Consider using PingProbeProtocolEnum instead Deprecated
type PingMonitorSummaryProtocolEnum = PingProbeProtocolEnum
PingProbe This model contains all of the mutable and immutable properties for a ping probe.
type PingProbe struct {
// The OCID of the resource.
Id *string `mandatory:"false" json:"id"`
// A URL for fetching the probe results.
ResultsUrl *string `mandatory:"false" json:"resultsUrl"`
// The region where updates must be made and where results must be fetched from.
HomeRegion *string `mandatory:"false" json:"homeRegion"`
// The RFC 3339-formatted creation date and time of the probe.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// A list of targets (hostnames or IP addresses) of the probe.
Targets []string `mandatory:"false" json:"targets"`
// A list of names of vantage points from which to execute the probe.
VantagePointNames []string `mandatory:"false" json:"vantagePointNames"`
// The port on which to probe endpoints. If unspecified, probes will use the
// default port of their protocol.
Port *int `mandatory:"false" json:"port"`
// The probe timeout in seconds. Valid values: 10, 20, 30, and 60.
// The probe timeout must be less than or equal to `intervalInSeconds` for monitors.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
Protocol PingProbeProtocolEnum `mandatory:"false" json:"protocol,omitempty"`
}
func (m PingProbe) String() string
func (m PingProbe) 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
PingProbeProtocolEnum Enum with underlying type: string
type PingProbeProtocolEnum string
Set of constants representing the allowable values for PingProbeProtocolEnum Deprecated
const (
CreateOnDemandPingProbeDetailsProtocolIcmp PingProbeProtocolEnum = "ICMP"
CreateOnDemandPingProbeDetailsProtocolTcp PingProbeProtocolEnum = "TCP"
)
Set of constants representing the allowable values for PingProbeProtocolEnum Deprecated
const (
CreatePingMonitorDetailsProtocolIcmp PingProbeProtocolEnum = "ICMP"
CreatePingMonitorDetailsProtocolTcp PingProbeProtocolEnum = "TCP"
)
Set of constants representing the allowable values for PingProbeProtocolEnum Deprecated
const (
PingMonitorProtocolIcmp PingProbeProtocolEnum = "ICMP"
PingMonitorProtocolTcp PingProbeProtocolEnum = "TCP"
)
Set of constants representing the allowable values for PingProbeProtocolEnum Deprecated
const (
PingMonitorSummaryProtocolIcmp PingProbeProtocolEnum = "ICMP"
PingMonitorSummaryProtocolTcp PingProbeProtocolEnum = "TCP"
)
Set of constants representing the allowable values for PingProbeProtocolEnum
const (
PingProbeProtocolIcmp PingProbeProtocolEnum = "ICMP"
PingProbeProtocolTcp PingProbeProtocolEnum = "TCP"
)
Set of constants representing the allowable values for PingProbeProtocolEnum Deprecated
const (
PingProbeResultSummaryProtocolIcmp PingProbeProtocolEnum = "ICMP"
PingProbeResultSummaryProtocolTcp PingProbeProtocolEnum = "TCP"
)
Set of constants representing the allowable values for PingProbeProtocolEnum Deprecated
const (
UpdatePingMonitorDetailsProtocolIcmp PingProbeProtocolEnum = "ICMP"
UpdatePingMonitorDetailsProtocolTcp PingProbeProtocolEnum = "TCP"
)
func GetMappingPingProbeProtocolEnum(val string) (PingProbeProtocolEnum, bool)
GetMappingPingProbeProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPingProbeProtocolEnumValues() []PingProbeProtocolEnum
GetPingProbeProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum
PingProbeResultSummary The results returned by running a ping probe. All times and durations are returned in milliseconds. All times are relative to the POSIX epoch (1970-01-01T00:00Z).
type PingProbeResultSummary struct {
// A value identifying this specific probe result. The key is only unique within
// the results of its probe configuration. The key may be reused after 90 days.
Key *string `mandatory:"false" json:"key"`
// The OCID of the monitor or on-demand probe responsible for creating this result.
ProbeConfigurationId *string `mandatory:"false" json:"probeConfigurationId"`
// The date and time the probe was executed, expressed in milliseconds since the
// POSIX epoch. This field is defined by the PerformanceResourceTiming interface
// of the W3C Resource Timing specification. For more information, see
// Resource Timing (https://w3c.github.io/resource-timing/#sec-resource-timing).
StartTime *float64 `mandatory:"false" json:"startTime"`
// The target hostname or IP address of the probe.
Target *string `mandatory:"false" json:"target"`
// The name of the vantage point that executed the probe.
VantagePointName *string `mandatory:"false" json:"vantagePointName"`
// True if the probe did not complete before the configured `timeoutInSeconds` value.
IsTimedOut *bool `mandatory:"false" json:"isTimedOut"`
// True if the probe result is determined to be healthy based on probe
// type-specific criteria. For HTTP probes, a probe result is considered
// healthy if the HTTP response code is greater than or equal to 200 and
// less than 300.
IsHealthy *bool `mandatory:"false" json:"isHealthy"`
// The category of error if an error occurs executing the probe.
// The `errorMessage` field provides a message with the error details.
// * NONE - No error
// * DNS - DNS errors
// * TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error.
// * NETWORK - Network-related errors, for example a "network unreachable" error.
// * SYSTEM - Internal system errors.
ErrorCategory PingProbeResultSummaryErrorCategoryEnum `mandatory:"false" json:"errorCategory,omitempty"`
// The error information indicating why a probe execution failed.
ErrorMessage *string `mandatory:"false" json:"errorMessage"`
Protocol PingProbeProtocolEnum `mandatory:"false" json:"protocol,omitempty"`
Connection *Connection `mandatory:"false" json:"connection"`
Dns *Dns `mandatory:"false" json:"dns"`
// The time immediately before the vantage point starts the domain name lookup for
// the resource.
DomainLookupStart *float64 `mandatory:"false" json:"domainLookupStart"`
// The time immediately before the vantage point finishes the domain name lookup for
// the resource.
DomainLookupEnd *float64 `mandatory:"false" json:"domainLookupEnd"`
// The latency of the probe execution, in milliseconds.
LatencyInMs *float64 `mandatory:"false" json:"latencyInMs"`
// The ICMP code of the response message. This field is not used when the protocol
// is set to TCP. For more information on ICMP codes, see
// Internet Control Message Protocol (ICMP) Parameters (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml).
IcmpCode *int `mandatory:"false" json:"icmpCode"`
}
func (m PingProbeResultSummary) String() string
func (m PingProbeResultSummary) 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
PingProbeResultSummaryErrorCategoryEnum Enum with underlying type: string
type PingProbeResultSummaryErrorCategoryEnum string
Set of constants representing the allowable values for PingProbeResultSummaryErrorCategoryEnum
const (
PingProbeResultSummaryErrorCategoryNone PingProbeResultSummaryErrorCategoryEnum = "NONE"
PingProbeResultSummaryErrorCategoryDns PingProbeResultSummaryErrorCategoryEnum = "DNS"
PingProbeResultSummaryErrorCategoryTransport PingProbeResultSummaryErrorCategoryEnum = "TRANSPORT"
PingProbeResultSummaryErrorCategoryNetwork PingProbeResultSummaryErrorCategoryEnum = "NETWORK"
PingProbeResultSummaryErrorCategorySystem PingProbeResultSummaryErrorCategoryEnum = "SYSTEM"
)
func GetMappingPingProbeResultSummaryErrorCategoryEnum(val string) (PingProbeResultSummaryErrorCategoryEnum, bool)
GetMappingPingProbeResultSummaryErrorCategoryEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPingProbeResultSummaryErrorCategoryEnumValues() []PingProbeResultSummaryErrorCategoryEnum
GetPingProbeResultSummaryErrorCategoryEnumValues Enumerates the set of values for PingProbeResultSummaryErrorCategoryEnum
PingProbeResultSummaryProtocolEnum is an alias to type: PingProbeProtocolEnum Consider using PingProbeProtocolEnum instead Deprecated
type PingProbeResultSummaryProtocolEnum = PingProbeProtocolEnum
Routing The routing information for a vantage point.
type Routing struct {
// The registry label for `asn`, usually the name of the organization that
// owns the ASN. May be omitted or null.
AsLabel *string `mandatory:"false" json:"asLabel"`
// The Autonomous System Number (ASN) identifying the organization
// responsible for routing packets to `prefix`.
Asn *int `mandatory:"false" json:"asn"`
// An IP prefix (CIDR syntax) that is less specific than
// `address`, through which `address` is routed.
Prefix *string `mandatory:"false" json:"prefix"`
// An integer between 0 and 100 used to select between multiple
// origin ASNs when routing to `prefix`. Most prefixes have
// exactly one origin ASN, in which case `weight` will be 100.
Weight *int `mandatory:"false" json:"weight"`
}
func (m Routing) String() string
func (m Routing) 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
TcpConnection TCP connection results. All durations are in milliseconds.
type TcpConnection struct {
// The connection IP address.
Address *string `mandatory:"false" json:"address"`
// The port.
Port *int `mandatory:"false" json:"port"`
// Total connect duration, calculated using `connectEnd` minus `connectStart`.
ConnectDuration *float64 `mandatory:"false" json:"connectDuration"`
// The duration to secure the connection. This value will be zero for
// insecure connections. Calculated using `connectEnd` minus `secureConnectionStart`.
SecureConnectDuration *float64 `mandatory:"false" json:"secureConnectDuration"`
}
func (m TcpConnection) String() string
func (m TcpConnection) 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
UpdateHttpMonitorDetails The request body used to update an HTTP monitor.
type UpdateHttpMonitorDetails struct {
// A list of targets (hostnames or IP addresses) of the probe.
Targets []string `mandatory:"false" json:"targets"`
// A list of names of vantage points from which to execute the probe.
VantagePointNames []string `mandatory:"false" json:"vantagePointNames"`
// The port on which to probe endpoints. If unspecified, probes will use the
// default port of their protocol.
Port *int `mandatory:"false" json:"port"`
// The probe timeout in seconds. Valid values: 10, 20, 30, and 60.
// The probe timeout must be less than or equal to `intervalInSeconds` for monitors.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
Protocol HttpProbeProtocolEnum `mandatory:"false" json:"protocol,omitempty"`
Method HttpProbeMethodEnum `mandatory:"false" json:"method,omitempty"`
// The optional URL path to probe, including query parameters.
Path *string `mandatory:"false" json:"path"`
// A dictionary of HTTP request headers.
// *Note:* Monitors and probes do not support the use of the `Authorization` HTTP header.
Headers map[string]string `mandatory:"false" json:"headers"`
// A user-friendly and mutable name suitable for display in a user interface.
DisplayName *string `mandatory:"false" json:"displayName"`
// The monitor interval in seconds. Valid values: 10, 30, and 60.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Enables or disables the monitor. Set to 'true' to launch monitoring.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// 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 UpdateHttpMonitorDetails) String() string
func (m UpdateHttpMonitorDetails) 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
UpdateHttpMonitorDetailsMethodEnum is an alias to type: HttpProbeMethodEnum Consider using HttpProbeMethodEnum instead Deprecated
type UpdateHttpMonitorDetailsMethodEnum = HttpProbeMethodEnum
UpdateHttpMonitorDetailsProtocolEnum is an alias to type: HttpProbeProtocolEnum Consider using HttpProbeProtocolEnum instead Deprecated
type UpdateHttpMonitorDetailsProtocolEnum = HttpProbeProtocolEnum
UpdateHttpMonitorRequest wrapper for the UpdateHttpMonitor operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/UpdateHttpMonitor.go.html to see an example of how to use UpdateHttpMonitorRequest.
type UpdateHttpMonitorRequest struct {
// The OCID of a monitor.
MonitorId *string `mandatory:"true" contributesTo:"path" name:"monitorId"`
// The configuration details to update for the HTTP monitor.
UpdateHttpMonitorDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `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 resource's current etag value.
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 UpdateHttpMonitorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateHttpMonitorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateHttpMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateHttpMonitorRequest) String() string
func (request UpdateHttpMonitorRequest) 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
UpdateHttpMonitorResponse wrapper for the UpdateHttpMonitor operation
type UpdateHttpMonitorResponse struct {
// The underlying http response
RawResponse *http.Response
// The HttpMonitor instance
HttpMonitor `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateHttpMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateHttpMonitorResponse) String() string
UpdatePingMonitorDetails The request body used to update a ping monitor.
type UpdatePingMonitorDetails struct {
// A list of targets (hostnames or IP addresses) of the probe.
Targets []string `mandatory:"false" json:"targets"`
// A list of names of vantage points from which to execute the probe.
VantagePointNames []string `mandatory:"false" json:"vantagePointNames"`
// The port on which to probe endpoints. If unspecified, probes will use the
// default port of their protocol.
Port *int `mandatory:"false" json:"port"`
// The probe timeout in seconds. Valid values: 10, 20, 30, and 60.
// The probe timeout must be less than or equal to `intervalInSeconds` for monitors.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
Protocol PingProbeProtocolEnum `mandatory:"false" json:"protocol,omitempty"`
// A user-friendly and mutable name suitable for display in a user interface.
DisplayName *string `mandatory:"false" json:"displayName"`
// The monitor interval in seconds. Valid values: 10, 30, and 60.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Enables or disables the monitor. Set to 'true' to launch monitoring.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// 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 UpdatePingMonitorDetails) String() string
func (m UpdatePingMonitorDetails) 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
UpdatePingMonitorDetailsProtocolEnum is an alias to type: PingProbeProtocolEnum Consider using PingProbeProtocolEnum instead Deprecated
type UpdatePingMonitorDetailsProtocolEnum = PingProbeProtocolEnum
UpdatePingMonitorRequest wrapper for the UpdatePingMonitor operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/healthchecks/UpdatePingMonitor.go.html to see an example of how to use UpdatePingMonitorRequest.
type UpdatePingMonitorRequest struct {
// The OCID of a monitor.
MonitorId *string `mandatory:"true" contributesTo:"path" name:"monitorId"`
// Details for updating a Ping monitor.
UpdatePingMonitorDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `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 resource's current etag value.
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 UpdatePingMonitorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePingMonitorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePingMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePingMonitorRequest) String() string
func (request UpdatePingMonitorRequest) 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
UpdatePingMonitorResponse wrapper for the UpdatePingMonitor operation
type UpdatePingMonitorResponse struct {
// The underlying http response
RawResponse *http.Response
// The PingMonitor instance
PingMonitor `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to
// contact Oracle about a particular request, please provide
// the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// An entity tag that uniquely identifies a version of the resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdatePingMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePingMonitorResponse) String() string