Documentation ¶
Index ¶
- Variables
- type ChangeHttpMonitorCompartmentDetails
- type ChangeHttpMonitorCompartmentRequest
- type ChangeHttpMonitorCompartmentResponse
- type ChangePingMonitorCompartmentDetails
- type ChangePingMonitorCompartmentRequest
- type ChangePingMonitorCompartmentResponse
- type Connection
- type CreateHttpMonitorDetails
- type CreateHttpMonitorDetailsMethodEnum
- type CreateHttpMonitorDetailsProtocolEnum
- type CreateHttpMonitorRequest
- type CreateHttpMonitorResponse
- type CreateOnDemandHttpProbeDetails
- type CreateOnDemandHttpProbeDetailsMethodEnum
- type CreateOnDemandHttpProbeDetailsProtocolEnum
- type CreateOnDemandHttpProbeRequest
- type CreateOnDemandHttpProbeResponse
- type CreateOnDemandPingProbeDetails
- type CreateOnDemandPingProbeDetailsProtocolEnum
- type CreateOnDemandPingProbeRequest
- type CreateOnDemandPingProbeResponse
- type CreatePingMonitorDetails
- type CreatePingMonitorDetailsProtocolEnum
- type CreatePingMonitorRequest
- type CreatePingMonitorResponse
- type DeleteHttpMonitorRequest
- type DeleteHttpMonitorResponse
- type DeletePingMonitorRequest
- type DeletePingMonitorResponse
- type Dns
- type Geolocation
- type GetHttpMonitorRequest
- type GetHttpMonitorResponse
- type GetPingMonitorRequest
- type GetPingMonitorResponse
- type HealthChecksClient
- func (client HealthChecksClient) ChangeHttpMonitorCompartment(ctx context.Context, request ChangeHttpMonitorCompartmentRequest) (response ChangeHttpMonitorCompartmentResponse, err error)
- func (client HealthChecksClient) ChangePingMonitorCompartment(ctx context.Context, request ChangePingMonitorCompartmentRequest) (response ChangePingMonitorCompartmentResponse, err error)
- func (client *HealthChecksClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client HealthChecksClient) CreateHttpMonitor(ctx context.Context, request CreateHttpMonitorRequest) (response CreateHttpMonitorResponse, err error)
- func (client HealthChecksClient) CreateOnDemandHttpProbe(ctx context.Context, request CreateOnDemandHttpProbeRequest) (response CreateOnDemandHttpProbeResponse, err error)
- func (client HealthChecksClient) CreateOnDemandPingProbe(ctx context.Context, request CreateOnDemandPingProbeRequest) (response CreateOnDemandPingProbeResponse, err error)
- func (client HealthChecksClient) CreatePingMonitor(ctx context.Context, request CreatePingMonitorRequest) (response CreatePingMonitorResponse, err error)
- func (client HealthChecksClient) DeleteHttpMonitor(ctx context.Context, request DeleteHttpMonitorRequest) (response DeleteHttpMonitorResponse, err error)
- func (client HealthChecksClient) DeletePingMonitor(ctx context.Context, request DeletePingMonitorRequest) (response DeletePingMonitorResponse, err error)
- func (client HealthChecksClient) GetHttpMonitor(ctx context.Context, request GetHttpMonitorRequest) (response GetHttpMonitorResponse, err error)
- func (client HealthChecksClient) GetPingMonitor(ctx context.Context, request GetPingMonitorRequest) (response GetPingMonitorResponse, err error)
- func (client HealthChecksClient) ListHealthChecksVantagePoints(ctx context.Context, request ListHealthChecksVantagePointsRequest) (response ListHealthChecksVantagePointsResponse, err error)
- func (client HealthChecksClient) ListHttpMonitors(ctx context.Context, request ListHttpMonitorsRequest) (response ListHttpMonitorsResponse, err error)
- func (client HealthChecksClient) ListHttpProbeResults(ctx context.Context, request ListHttpProbeResultsRequest) (response ListHttpProbeResultsResponse, err error)
- func (client HealthChecksClient) ListPingMonitors(ctx context.Context, request ListPingMonitorsRequest) (response ListPingMonitorsResponse, err error)
- func (client HealthChecksClient) ListPingProbeResults(ctx context.Context, request ListPingProbeResultsRequest) (response ListPingProbeResultsResponse, err error)
- func (client *HealthChecksClient) SetRegion(region string)
- func (client HealthChecksClient) UpdateHttpMonitor(ctx context.Context, request UpdateHttpMonitorRequest) (response UpdateHttpMonitorResponse, err error)
- func (client HealthChecksClient) UpdatePingMonitor(ctx context.Context, request UpdatePingMonitorRequest) (response UpdatePingMonitorResponse, err error)
- type HealthChecksVantagePointSummary
- type HttpMonitor
- type HttpMonitorMethodEnum
- type HttpMonitorProtocolEnum
- type HttpMonitorSummary
- type HttpMonitorSummaryProtocolEnum
- type HttpProbe
- type HttpProbeMethodEnum
- type HttpProbeProtocolEnum
- type HttpProbeResultSummary
- type HttpProbeResultSummaryErrorCategoryEnum
- type HttpProbeResultSummaryProtocolEnum
- type ListHealthChecksVantagePointsRequest
- type ListHealthChecksVantagePointsResponse
- type ListHealthChecksVantagePointsSortByEnum
- type ListHealthChecksVantagePointsSortOrderEnum
- type ListHttpMonitorsRequest
- type ListHttpMonitorsResponse
- type ListHttpMonitorsSortByEnum
- type ListHttpMonitorsSortOrderEnum
- type ListHttpProbeResultsRequest
- type ListHttpProbeResultsResponse
- type ListHttpProbeResultsSortOrderEnum
- type ListPingMonitorsRequest
- type ListPingMonitorsResponse
- type ListPingMonitorsSortByEnum
- type ListPingMonitorsSortOrderEnum
- type ListPingProbeResultsRequest
- type ListPingProbeResultsResponse
- type ListPingProbeResultsSortOrderEnum
- type PingMonitor
- type PingMonitorProtocolEnum
- type PingMonitorSummary
- type PingMonitorSummaryProtocolEnum
- type PingProbe
- type PingProbeProtocolEnum
- type PingProbeResultSummary
- type PingProbeResultSummaryErrorCategoryEnum
- type PingProbeResultSummaryProtocolEnum
- type Routing
- type TcpConnection
- type UpdateHttpMonitorDetails
- type UpdateHttpMonitorDetailsMethodEnum
- type UpdateHttpMonitorDetailsProtocolEnum
- type UpdateHttpMonitorRequest
- type UpdateHttpMonitorResponse
- type UpdatePingMonitorDetails
- type UpdatePingMonitorDetailsProtocolEnum
- type UpdatePingMonitorRequest
- type UpdatePingMonitorResponse
Constants ¶
This section is empty.
Variables ¶
var GetCreateHttpMonitorDetailsMethodEnumValues = GetHttpProbeMethodEnumValues
GetCreateHttpMonitorDetailsMethodEnumValues Enumerates the set of values for HttpProbeMethodEnum Consider using GetHttpProbeMethodEnumValue Deprecated
var GetCreateHttpMonitorDetailsProtocolEnumValues = GetHttpProbeProtocolEnumValues
GetCreateHttpMonitorDetailsProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum Consider using GetHttpProbeProtocolEnumValue Deprecated
var GetCreateOnDemandHttpProbeDetailsMethodEnumValues = GetHttpProbeMethodEnumValues
GetCreateOnDemandHttpProbeDetailsMethodEnumValues Enumerates the set of values for HttpProbeMethodEnum Consider using GetHttpProbeMethodEnumValue Deprecated
var GetCreateOnDemandHttpProbeDetailsProtocolEnumValues = GetHttpProbeProtocolEnumValues
GetCreateOnDemandHttpProbeDetailsProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum Consider using GetHttpProbeProtocolEnumValue Deprecated
var GetCreateOnDemandPingProbeDetailsProtocolEnumValues = GetPingProbeProtocolEnumValues
GetCreateOnDemandPingProbeDetailsProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum Consider using GetPingProbeProtocolEnumValue Deprecated
var GetCreatePingMonitorDetailsProtocolEnumValues = GetPingProbeProtocolEnumValues
GetCreatePingMonitorDetailsProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum Consider using GetPingProbeProtocolEnumValue Deprecated
var GetHttpMonitorMethodEnumValues = GetHttpProbeMethodEnumValues
GetHttpMonitorMethodEnumValues Enumerates the set of values for HttpProbeMethodEnum Consider using GetHttpProbeMethodEnumValue Deprecated
var GetHttpMonitorProtocolEnumValues = GetHttpProbeProtocolEnumValues
GetHttpMonitorProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum Consider using GetHttpProbeProtocolEnumValue Deprecated
var GetHttpMonitorSummaryProtocolEnumValues = GetHttpProbeProtocolEnumValues
GetHttpMonitorSummaryProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum Consider using GetHttpProbeProtocolEnumValue Deprecated
var GetHttpProbeResultSummaryProtocolEnumValues = GetHttpProbeProtocolEnumValues
GetHttpProbeResultSummaryProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum Consider using GetHttpProbeProtocolEnumValue Deprecated
var GetPingMonitorProtocolEnumValues = GetPingProbeProtocolEnumValues
GetPingMonitorProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum Consider using GetPingProbeProtocolEnumValue Deprecated
var GetPingMonitorSummaryProtocolEnumValues = GetPingProbeProtocolEnumValues
GetPingMonitorSummaryProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum Consider using GetPingProbeProtocolEnumValue Deprecated
var GetPingProbeResultSummaryProtocolEnumValues = GetPingProbeProtocolEnumValues
GetPingProbeResultSummaryProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum Consider using GetPingProbeProtocolEnumValue Deprecated
var GetUpdateHttpMonitorDetailsMethodEnumValues = GetHttpProbeMethodEnumValues
GetUpdateHttpMonitorDetailsMethodEnumValues Enumerates the set of values for HttpProbeMethodEnum Consider using GetHttpProbeMethodEnumValue Deprecated
var GetUpdateHttpMonitorDetailsProtocolEnumValues = GetHttpProbeProtocolEnumValues
GetUpdateHttpMonitorDetailsProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum Consider using GetHttpProbeProtocolEnumValue Deprecated
var GetUpdatePingMonitorDetailsProtocolEnumValues = GetPingProbeProtocolEnumValues
GetUpdatePingMonitorDetailsProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum Consider using GetPingProbeProtocolEnumValue Deprecated
Functions ¶
This section is empty.
Types ¶
type ChangeHttpMonitorCompartmentDetails ¶
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"` }
ChangeHttpMonitorCompartmentDetails The request body used to move a monitor into a compartment.
func (ChangeHttpMonitorCompartmentDetails) String ¶
func (m ChangeHttpMonitorCompartmentDetails) String() string
type 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 }
ChangeHttpMonitorCompartmentRequest wrapper for the ChangeHttpMonitorCompartment operation
func (ChangeHttpMonitorCompartmentRequest) HTTPRequest ¶
func (request ChangeHttpMonitorCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ChangeHttpMonitorCompartmentRequest) RetryPolicy ¶
func (request ChangeHttpMonitorCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ChangeHttpMonitorCompartmentRequest) String ¶
func (request ChangeHttpMonitorCompartmentRequest) String() string
type ChangeHttpMonitorCompartmentResponse ¶
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"` }
ChangeHttpMonitorCompartmentResponse wrapper for the ChangeHttpMonitorCompartment operation
func (ChangeHttpMonitorCompartmentResponse) HTTPResponse ¶
func (response ChangeHttpMonitorCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ChangeHttpMonitorCompartmentResponse) String ¶
func (response ChangeHttpMonitorCompartmentResponse) String() string
type ChangePingMonitorCompartmentDetails ¶
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"` }
ChangePingMonitorCompartmentDetails The request body used to move a monitor into a compartment.
func (ChangePingMonitorCompartmentDetails) String ¶
func (m ChangePingMonitorCompartmentDetails) String() string
type 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 }
ChangePingMonitorCompartmentRequest wrapper for the ChangePingMonitorCompartment operation
func (ChangePingMonitorCompartmentRequest) HTTPRequest ¶
func (request ChangePingMonitorCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ChangePingMonitorCompartmentRequest) RetryPolicy ¶
func (request ChangePingMonitorCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ChangePingMonitorCompartmentRequest) String ¶
func (request ChangePingMonitorCompartmentRequest) String() string
type ChangePingMonitorCompartmentResponse ¶
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"` }
ChangePingMonitorCompartmentResponse wrapper for the ChangePingMonitorCompartment operation
func (ChangePingMonitorCompartmentResponse) HTTPResponse ¶
func (response ChangePingMonitorCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ChangePingMonitorCompartmentResponse) String ¶
func (response ChangePingMonitorCompartmentResponse) String() string
type Connection ¶
type Connection struct { // The connection IP address. Address *string `mandatory:"false" json:"address"` // The port. Port *int `mandatory:"false" json:"port"` }
Connection The network connection results.
func (Connection) String ¶
func (m Connection) String() string
type CreateHttpMonitorDetails ¶
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"` }
CreateHttpMonitorDetails The request body used to create an HTTP monitor.
func (CreateHttpMonitorDetails) String ¶
func (m CreateHttpMonitorDetails) String() string
type CreateHttpMonitorDetailsMethodEnum ¶
type CreateHttpMonitorDetailsMethodEnum = HttpProbeMethodEnum
CreateHttpMonitorDetailsMethodEnum is an alias to type: HttpProbeMethodEnum Consider using HttpProbeMethodEnum instead Deprecated
type CreateHttpMonitorDetailsProtocolEnum ¶
type CreateHttpMonitorDetailsProtocolEnum = HttpProbeProtocolEnum
CreateHttpMonitorDetailsProtocolEnum is an alias to type: HttpProbeProtocolEnum Consider using HttpProbeProtocolEnum instead Deprecated
type 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 }
CreateHttpMonitorRequest wrapper for the CreateHttpMonitor operation
func (CreateHttpMonitorRequest) HTTPRequest ¶
func (request CreateHttpMonitorRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CreateHttpMonitorRequest) RetryPolicy ¶
func (request CreateHttpMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CreateHttpMonitorRequest) String ¶
func (request CreateHttpMonitorRequest) String() string
type CreateHttpMonitorResponse ¶
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"` }
CreateHttpMonitorResponse wrapper for the CreateHttpMonitor operation
func (CreateHttpMonitorResponse) HTTPResponse ¶
func (response CreateHttpMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateHttpMonitorResponse) String ¶
func (response CreateHttpMonitorResponse) String() string
type CreateOnDemandHttpProbeDetails ¶
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"` }
CreateOnDemandHttpProbeDetails The request body used to create an on-demand HTTP probe.
func (CreateOnDemandHttpProbeDetails) String ¶
func (m CreateOnDemandHttpProbeDetails) String() string
type CreateOnDemandHttpProbeDetailsMethodEnum ¶
type CreateOnDemandHttpProbeDetailsMethodEnum = HttpProbeMethodEnum
CreateOnDemandHttpProbeDetailsMethodEnum is an alias to type: HttpProbeMethodEnum Consider using HttpProbeMethodEnum instead Deprecated
type CreateOnDemandHttpProbeDetailsProtocolEnum ¶
type CreateOnDemandHttpProbeDetailsProtocolEnum = HttpProbeProtocolEnum
CreateOnDemandHttpProbeDetailsProtocolEnum is an alias to type: HttpProbeProtocolEnum Consider using HttpProbeProtocolEnum instead Deprecated
type 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 }
CreateOnDemandHttpProbeRequest wrapper for the CreateOnDemandHttpProbe operation
func (CreateOnDemandHttpProbeRequest) HTTPRequest ¶
func (request CreateOnDemandHttpProbeRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CreateOnDemandHttpProbeRequest) RetryPolicy ¶
func (request CreateOnDemandHttpProbeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CreateOnDemandHttpProbeRequest) String ¶
func (request CreateOnDemandHttpProbeRequest) String() string
type CreateOnDemandHttpProbeResponse ¶
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"` }
CreateOnDemandHttpProbeResponse wrapper for the CreateOnDemandHttpProbe operation
func (CreateOnDemandHttpProbeResponse) HTTPResponse ¶
func (response CreateOnDemandHttpProbeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateOnDemandHttpProbeResponse) String ¶
func (response CreateOnDemandHttpProbeResponse) String() string
type CreateOnDemandPingProbeDetails ¶
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"` }
CreateOnDemandPingProbeDetails The request body used to create an on-demand ping probe.
func (CreateOnDemandPingProbeDetails) String ¶
func (m CreateOnDemandPingProbeDetails) String() string
type CreateOnDemandPingProbeDetailsProtocolEnum ¶
type CreateOnDemandPingProbeDetailsProtocolEnum = PingProbeProtocolEnum
CreateOnDemandPingProbeDetailsProtocolEnum is an alias to type: PingProbeProtocolEnum Consider using PingProbeProtocolEnum instead Deprecated
type 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 }
CreateOnDemandPingProbeRequest wrapper for the CreateOnDemandPingProbe operation
func (CreateOnDemandPingProbeRequest) HTTPRequest ¶
func (request CreateOnDemandPingProbeRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CreateOnDemandPingProbeRequest) RetryPolicy ¶
func (request CreateOnDemandPingProbeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CreateOnDemandPingProbeRequest) String ¶
func (request CreateOnDemandPingProbeRequest) String() string
type CreateOnDemandPingProbeResponse ¶
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"` }
CreateOnDemandPingProbeResponse wrapper for the CreateOnDemandPingProbe operation
func (CreateOnDemandPingProbeResponse) HTTPResponse ¶
func (response CreateOnDemandPingProbeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateOnDemandPingProbeResponse) String ¶
func (response CreateOnDemandPingProbeResponse) String() string
type CreatePingMonitorDetails ¶
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"` }
CreatePingMonitorDetails The request body used to create a Ping monitor.
func (CreatePingMonitorDetails) String ¶
func (m CreatePingMonitorDetails) String() string
type CreatePingMonitorDetailsProtocolEnum ¶
type CreatePingMonitorDetailsProtocolEnum = PingProbeProtocolEnum
CreatePingMonitorDetailsProtocolEnum is an alias to type: PingProbeProtocolEnum Consider using PingProbeProtocolEnum instead Deprecated
type 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 }
CreatePingMonitorRequest wrapper for the CreatePingMonitor operation
func (CreatePingMonitorRequest) HTTPRequest ¶
func (request CreatePingMonitorRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CreatePingMonitorRequest) RetryPolicy ¶
func (request CreatePingMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CreatePingMonitorRequest) String ¶
func (request CreatePingMonitorRequest) String() string
type CreatePingMonitorResponse ¶
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"` }
CreatePingMonitorResponse wrapper for the CreatePingMonitor operation
func (CreatePingMonitorResponse) HTTPResponse ¶
func (response CreatePingMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreatePingMonitorResponse) String ¶
func (response CreatePingMonitorResponse) String() string
type 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 }
DeleteHttpMonitorRequest wrapper for the DeleteHttpMonitor operation
func (DeleteHttpMonitorRequest) HTTPRequest ¶
func (request DeleteHttpMonitorRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (DeleteHttpMonitorRequest) RetryPolicy ¶
func (request DeleteHttpMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (DeleteHttpMonitorRequest) String ¶
func (request DeleteHttpMonitorRequest) String() string
type DeleteHttpMonitorResponse ¶
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"` }
DeleteHttpMonitorResponse wrapper for the DeleteHttpMonitor operation
func (DeleteHttpMonitorResponse) HTTPResponse ¶
func (response DeleteHttpMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (DeleteHttpMonitorResponse) String ¶
func (response DeleteHttpMonitorResponse) String() string
type 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 }
DeletePingMonitorRequest wrapper for the DeletePingMonitor operation
func (DeletePingMonitorRequest) HTTPRequest ¶
func (request DeletePingMonitorRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (DeletePingMonitorRequest) RetryPolicy ¶
func (request DeletePingMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (DeletePingMonitorRequest) String ¶
func (request DeletePingMonitorRequest) String() string
type DeletePingMonitorResponse ¶
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"` }
DeletePingMonitorResponse wrapper for the DeletePingMonitor operation
func (DeletePingMonitorResponse) HTTPResponse ¶
func (response DeletePingMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (DeletePingMonitorResponse) String ¶
func (response DeletePingMonitorResponse) String() string
type Dns ¶
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"` }
Dns The DNS resolution results.
type Geolocation ¶
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"` }
Geolocation Geographic information about a vantage point.
func (Geolocation) String ¶
func (m Geolocation) String() string
type 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 }
GetHttpMonitorRequest wrapper for the GetHttpMonitor operation
func (GetHttpMonitorRequest) HTTPRequest ¶
func (request GetHttpMonitorRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetHttpMonitorRequest) RetryPolicy ¶
func (request GetHttpMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetHttpMonitorRequest) String ¶
func (request GetHttpMonitorRequest) String() string
type GetHttpMonitorResponse ¶
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 }
GetHttpMonitorResponse wrapper for the GetHttpMonitor operation
func (GetHttpMonitorResponse) HTTPResponse ¶
func (response GetHttpMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetHttpMonitorResponse) String ¶
func (response GetHttpMonitorResponse) String() string
type 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 }
GetPingMonitorRequest wrapper for the GetPingMonitor operation
func (GetPingMonitorRequest) HTTPRequest ¶
func (request GetPingMonitorRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetPingMonitorRequest) RetryPolicy ¶
func (request GetPingMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetPingMonitorRequest) String ¶
func (request GetPingMonitorRequest) String() string
type GetPingMonitorResponse ¶
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 }
GetPingMonitorResponse wrapper for the GetPingMonitor operation
func (GetPingMonitorResponse) HTTPResponse ¶
func (response GetPingMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetPingMonitorResponse) String ¶
func (response GetPingMonitorResponse) String() string
type HealthChecksClient ¶
type HealthChecksClient struct { common.BaseClient // contains filtered or unexported fields }
HealthChecksClient a client for HealthChecks
func NewHealthChecksClientWithConfigurationProvider ¶
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 (HealthChecksClient) ChangeHttpMonitorCompartment ¶
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.
func (HealthChecksClient) ChangePingMonitorCompartment ¶
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.
func (*HealthChecksClient) ConfigurationProvider ¶
func (client *HealthChecksClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (HealthChecksClient) CreateHttpMonitor ¶
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`.
func (HealthChecksClient) CreateOnDemandHttpProbe ¶
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.
func (HealthChecksClient) CreateOnDemandPingProbe ¶
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.
func (HealthChecksClient) CreatePingMonitor ¶
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`.
func (HealthChecksClient) DeleteHttpMonitor ¶
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.
func (HealthChecksClient) DeletePingMonitor ¶
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.
func (HealthChecksClient) GetHttpMonitor ¶
func (client HealthChecksClient) GetHttpMonitor(ctx context.Context, request GetHttpMonitorRequest) (response GetHttpMonitorResponse, err error)
GetHttpMonitor Gets the configuration for the specified monitor.
func (HealthChecksClient) GetPingMonitor ¶
func (client HealthChecksClient) GetPingMonitor(ctx context.Context, request GetPingMonitorRequest) (response GetPingMonitorResponse, err error)
GetPingMonitor Gets the configuration for the specified ping monitor.
func (HealthChecksClient) ListHealthChecksVantagePoints ¶
func (client HealthChecksClient) ListHealthChecksVantagePoints(ctx context.Context, request ListHealthChecksVantagePointsRequest) (response ListHealthChecksVantagePointsResponse, err error)
ListHealthChecksVantagePoints Gets information about all vantage points available to the user.
func (HealthChecksClient) ListHttpMonitors ¶
func (client HealthChecksClient) ListHttpMonitors(ctx context.Context, request ListHttpMonitorsRequest) (response ListHttpMonitorsResponse, err error)
ListHttpMonitors Gets a list of HTTP monitors.
func (HealthChecksClient) ListHttpProbeResults ¶
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.
func (HealthChecksClient) ListPingMonitors ¶
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.
func (HealthChecksClient) ListPingProbeResults ¶
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`.
func (*HealthChecksClient) SetRegion ¶
func (client *HealthChecksClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (HealthChecksClient) UpdateHttpMonitor ¶
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.
func (HealthChecksClient) UpdatePingMonitor ¶
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.
type HealthChecksVantagePointSummary ¶
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"` }
HealthChecksVantagePointSummary Information about a vantage point.
func (HealthChecksVantagePointSummary) String ¶
func (m HealthChecksVantagePointSummary) String() string
type HttpMonitor ¶
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"` }
HttpMonitor This model contains all of the mutable and immutable properties for an HTTP monitor.
func (HttpMonitor) String ¶
func (m HttpMonitor) String() string
type HttpMonitorMethodEnum ¶
type HttpMonitorMethodEnum = HttpProbeMethodEnum
HttpMonitorMethodEnum is an alias to type: HttpProbeMethodEnum Consider using HttpProbeMethodEnum instead Deprecated
type HttpMonitorProtocolEnum ¶
type HttpMonitorProtocolEnum = HttpProbeProtocolEnum
HttpMonitorProtocolEnum is an alias to type: HttpProbeProtocolEnum Consider using HttpProbeProtocolEnum instead Deprecated
type HttpMonitorSummary ¶
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"` }
HttpMonitorSummary A summary containing all of the mutable and immutable properties for an HTTP monitor.
func (HttpMonitorSummary) String ¶
func (m HttpMonitorSummary) String() string
type HttpMonitorSummaryProtocolEnum ¶
type HttpMonitorSummaryProtocolEnum = HttpProbeProtocolEnum
HttpMonitorSummaryProtocolEnum is an alias to type: HttpProbeProtocolEnum Consider using HttpProbeProtocolEnum instead Deprecated
type HttpProbe ¶
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"` }
HttpProbe A summary that contains all of the mutable and immutable properties for an HTTP probe.
type HttpProbeMethodEnum ¶
type HttpProbeMethodEnum string
HttpProbeMethodEnum Enum with underlying type: string
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 Deprecated
const ( HttpProbeMethodGet HttpProbeMethodEnum = "GET" HttpProbeMethodHead HttpProbeMethodEnum = "HEAD" )
Set of constants representing the allowable values for HttpProbeMethodEnum
const ( UpdateHttpMonitorDetailsMethodGet HttpProbeMethodEnum = "GET" UpdateHttpMonitorDetailsMethodHead HttpProbeMethodEnum = "HEAD" )
Set of constants representing the allowable values for HttpProbeMethodEnum Deprecated
func GetHttpProbeMethodEnumValues ¶
func GetHttpProbeMethodEnumValues() []HttpProbeMethodEnum
GetHttpProbeMethodEnumValues Enumerates the set of values for HttpProbeMethodEnum
type HttpProbeProtocolEnum ¶
type HttpProbeProtocolEnum string
HttpProbeProtocolEnum Enum with underlying type: string
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 Deprecated
const ( HttpProbeProtocolHttp HttpProbeProtocolEnum = "HTTP" HttpProbeProtocolHttps HttpProbeProtocolEnum = "HTTPS" )
Set of constants representing the allowable values for HttpProbeProtocolEnum
const ( HttpProbeResultSummaryProtocolHttp HttpProbeProtocolEnum = "HTTP" HttpProbeResultSummaryProtocolHttps HttpProbeProtocolEnum = "HTTPS" )
Set of constants representing the allowable values for HttpProbeProtocolEnum Deprecated
const ( UpdateHttpMonitorDetailsProtocolHttp HttpProbeProtocolEnum = "HTTP" UpdateHttpMonitorDetailsProtocolHttps HttpProbeProtocolEnum = "HTTPS" )
Set of constants representing the allowable values for HttpProbeProtocolEnum Deprecated
func GetHttpProbeProtocolEnumValues ¶
func GetHttpProbeProtocolEnumValues() []HttpProbeProtocolEnum
GetHttpProbeProtocolEnumValues Enumerates the set of values for HttpProbeProtocolEnum
type HttpProbeResultSummary ¶
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"` }
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.
func (HttpProbeResultSummary) String ¶
func (m HttpProbeResultSummary) String() string
type HttpProbeResultSummaryErrorCategoryEnum ¶
type HttpProbeResultSummaryErrorCategoryEnum string
HttpProbeResultSummaryErrorCategoryEnum Enum with underlying type: string
const ( HttpProbeResultSummaryErrorCategoryNone HttpProbeResultSummaryErrorCategoryEnum = "NONE" HttpProbeResultSummaryErrorCategoryDns HttpProbeResultSummaryErrorCategoryEnum = "DNS" HttpProbeResultSummaryErrorCategoryTransport HttpProbeResultSummaryErrorCategoryEnum = "TRANSPORT" HttpProbeResultSummaryErrorCategoryNetwork HttpProbeResultSummaryErrorCategoryEnum = "NETWORK" HttpProbeResultSummaryErrorCategorySystem HttpProbeResultSummaryErrorCategoryEnum = "SYSTEM" )
Set of constants representing the allowable values for HttpProbeResultSummaryErrorCategoryEnum
func GetHttpProbeResultSummaryErrorCategoryEnumValues ¶
func GetHttpProbeResultSummaryErrorCategoryEnumValues() []HttpProbeResultSummaryErrorCategoryEnum
GetHttpProbeResultSummaryErrorCategoryEnumValues Enumerates the set of values for HttpProbeResultSummaryErrorCategoryEnum
type HttpProbeResultSummaryProtocolEnum ¶
type HttpProbeResultSummaryProtocolEnum = HttpProbeProtocolEnum
HttpProbeResultSummaryProtocolEnum is an alias to type: HttpProbeProtocolEnum Consider using HttpProbeProtocolEnum instead Deprecated
type 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 }
ListHealthChecksVantagePointsRequest wrapper for the ListHealthChecksVantagePoints operation
func (ListHealthChecksVantagePointsRequest) HTTPRequest ¶
func (request ListHealthChecksVantagePointsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListHealthChecksVantagePointsRequest) RetryPolicy ¶
func (request ListHealthChecksVantagePointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListHealthChecksVantagePointsRequest) String ¶
func (request ListHealthChecksVantagePointsRequest) String() string
type ListHealthChecksVantagePointsResponse ¶
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"` }
ListHealthChecksVantagePointsResponse wrapper for the ListHealthChecksVantagePoints operation
func (ListHealthChecksVantagePointsResponse) HTTPResponse ¶
func (response ListHealthChecksVantagePointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListHealthChecksVantagePointsResponse) String ¶
func (response ListHealthChecksVantagePointsResponse) String() string
type ListHealthChecksVantagePointsSortByEnum ¶
type ListHealthChecksVantagePointsSortByEnum string
ListHealthChecksVantagePointsSortByEnum Enum with underlying type: string
const ( ListHealthChecksVantagePointsSortByName ListHealthChecksVantagePointsSortByEnum = "name" ListHealthChecksVantagePointsSortByDisplayname ListHealthChecksVantagePointsSortByEnum = "displayName" )
Set of constants representing the allowable values for ListHealthChecksVantagePointsSortByEnum
func GetListHealthChecksVantagePointsSortByEnumValues ¶
func GetListHealthChecksVantagePointsSortByEnumValues() []ListHealthChecksVantagePointsSortByEnum
GetListHealthChecksVantagePointsSortByEnumValues Enumerates the set of values for ListHealthChecksVantagePointsSortByEnum
type ListHealthChecksVantagePointsSortOrderEnum ¶
type ListHealthChecksVantagePointsSortOrderEnum string
ListHealthChecksVantagePointsSortOrderEnum Enum with underlying type: string
const ( ListHealthChecksVantagePointsSortOrderAsc ListHealthChecksVantagePointsSortOrderEnum = "ASC" ListHealthChecksVantagePointsSortOrderDesc ListHealthChecksVantagePointsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListHealthChecksVantagePointsSortOrderEnum
func GetListHealthChecksVantagePointsSortOrderEnumValues ¶
func GetListHealthChecksVantagePointsSortOrderEnumValues() []ListHealthChecksVantagePointsSortOrderEnum
GetListHealthChecksVantagePointsSortOrderEnumValues Enumerates the set of values for ListHealthChecksVantagePointsSortOrderEnum
type 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 }
ListHttpMonitorsRequest wrapper for the ListHttpMonitors operation
func (ListHttpMonitorsRequest) HTTPRequest ¶
func (request ListHttpMonitorsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListHttpMonitorsRequest) RetryPolicy ¶
func (request ListHttpMonitorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListHttpMonitorsRequest) String ¶
func (request ListHttpMonitorsRequest) String() string
type ListHttpMonitorsResponse ¶
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"` }
ListHttpMonitorsResponse wrapper for the ListHttpMonitors operation
func (ListHttpMonitorsResponse) HTTPResponse ¶
func (response ListHttpMonitorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListHttpMonitorsResponse) String ¶
func (response ListHttpMonitorsResponse) String() string
type ListHttpMonitorsSortByEnum ¶
type ListHttpMonitorsSortByEnum string
ListHttpMonitorsSortByEnum Enum with underlying type: string
const ( ListHttpMonitorsSortById ListHttpMonitorsSortByEnum = "id" ListHttpMonitorsSortByDisplayname ListHttpMonitorsSortByEnum = "displayName" ListHttpMonitorsSortByTimecreated ListHttpMonitorsSortByEnum = "timeCreated" )
Set of constants representing the allowable values for ListHttpMonitorsSortByEnum
func GetListHttpMonitorsSortByEnumValues ¶
func GetListHttpMonitorsSortByEnumValues() []ListHttpMonitorsSortByEnum
GetListHttpMonitorsSortByEnumValues Enumerates the set of values for ListHttpMonitorsSortByEnum
type ListHttpMonitorsSortOrderEnum ¶
type ListHttpMonitorsSortOrderEnum string
ListHttpMonitorsSortOrderEnum Enum with underlying type: string
const ( ListHttpMonitorsSortOrderAsc ListHttpMonitorsSortOrderEnum = "ASC" ListHttpMonitorsSortOrderDesc ListHttpMonitorsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListHttpMonitorsSortOrderEnum
func GetListHttpMonitorsSortOrderEnumValues ¶
func GetListHttpMonitorsSortOrderEnumValues() []ListHttpMonitorsSortOrderEnum
GetListHttpMonitorsSortOrderEnumValues Enumerates the set of values for ListHttpMonitorsSortOrderEnum
type 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 }
ListHttpProbeResultsRequest wrapper for the ListHttpProbeResults operation
func (ListHttpProbeResultsRequest) HTTPRequest ¶
func (request ListHttpProbeResultsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListHttpProbeResultsRequest) RetryPolicy ¶
func (request ListHttpProbeResultsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListHttpProbeResultsRequest) String ¶
func (request ListHttpProbeResultsRequest) String() string
type ListHttpProbeResultsResponse ¶
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"` }
ListHttpProbeResultsResponse wrapper for the ListHttpProbeResults operation
func (ListHttpProbeResultsResponse) HTTPResponse ¶
func (response ListHttpProbeResultsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListHttpProbeResultsResponse) String ¶
func (response ListHttpProbeResultsResponse) String() string
type ListHttpProbeResultsSortOrderEnum ¶
type ListHttpProbeResultsSortOrderEnum string
ListHttpProbeResultsSortOrderEnum Enum with underlying type: string
const ( ListHttpProbeResultsSortOrderAsc ListHttpProbeResultsSortOrderEnum = "ASC" ListHttpProbeResultsSortOrderDesc ListHttpProbeResultsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListHttpProbeResultsSortOrderEnum
func GetListHttpProbeResultsSortOrderEnumValues ¶
func GetListHttpProbeResultsSortOrderEnumValues() []ListHttpProbeResultsSortOrderEnum
GetListHttpProbeResultsSortOrderEnumValues Enumerates the set of values for ListHttpProbeResultsSortOrderEnum
type 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 }
ListPingMonitorsRequest wrapper for the ListPingMonitors operation
func (ListPingMonitorsRequest) HTTPRequest ¶
func (request ListPingMonitorsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListPingMonitorsRequest) RetryPolicy ¶
func (request ListPingMonitorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListPingMonitorsRequest) String ¶
func (request ListPingMonitorsRequest) String() string
type ListPingMonitorsResponse ¶
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"` }
ListPingMonitorsResponse wrapper for the ListPingMonitors operation
func (ListPingMonitorsResponse) HTTPResponse ¶
func (response ListPingMonitorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListPingMonitorsResponse) String ¶
func (response ListPingMonitorsResponse) String() string
type ListPingMonitorsSortByEnum ¶
type ListPingMonitorsSortByEnum string
ListPingMonitorsSortByEnum Enum with underlying type: string
const ( ListPingMonitorsSortById ListPingMonitorsSortByEnum = "id" ListPingMonitorsSortByDisplayname ListPingMonitorsSortByEnum = "displayName" ListPingMonitorsSortByTimecreated ListPingMonitorsSortByEnum = "timeCreated" )
Set of constants representing the allowable values for ListPingMonitorsSortByEnum
func GetListPingMonitorsSortByEnumValues ¶
func GetListPingMonitorsSortByEnumValues() []ListPingMonitorsSortByEnum
GetListPingMonitorsSortByEnumValues Enumerates the set of values for ListPingMonitorsSortByEnum
type ListPingMonitorsSortOrderEnum ¶
type ListPingMonitorsSortOrderEnum string
ListPingMonitorsSortOrderEnum Enum with underlying type: string
const ( ListPingMonitorsSortOrderAsc ListPingMonitorsSortOrderEnum = "ASC" ListPingMonitorsSortOrderDesc ListPingMonitorsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListPingMonitorsSortOrderEnum
func GetListPingMonitorsSortOrderEnumValues ¶
func GetListPingMonitorsSortOrderEnumValues() []ListPingMonitorsSortOrderEnum
GetListPingMonitorsSortOrderEnumValues Enumerates the set of values for ListPingMonitorsSortOrderEnum
type 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 }
ListPingProbeResultsRequest wrapper for the ListPingProbeResults operation
func (ListPingProbeResultsRequest) HTTPRequest ¶
func (request ListPingProbeResultsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListPingProbeResultsRequest) RetryPolicy ¶
func (request ListPingProbeResultsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListPingProbeResultsRequest) String ¶
func (request ListPingProbeResultsRequest) String() string
type ListPingProbeResultsResponse ¶
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"` }
ListPingProbeResultsResponse wrapper for the ListPingProbeResults operation
func (ListPingProbeResultsResponse) HTTPResponse ¶
func (response ListPingProbeResultsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListPingProbeResultsResponse) String ¶
func (response ListPingProbeResultsResponse) String() string
type ListPingProbeResultsSortOrderEnum ¶
type ListPingProbeResultsSortOrderEnum string
ListPingProbeResultsSortOrderEnum Enum with underlying type: string
const ( ListPingProbeResultsSortOrderAsc ListPingProbeResultsSortOrderEnum = "ASC" ListPingProbeResultsSortOrderDesc ListPingProbeResultsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListPingProbeResultsSortOrderEnum
func GetListPingProbeResultsSortOrderEnumValues ¶
func GetListPingProbeResultsSortOrderEnumValues() []ListPingProbeResultsSortOrderEnum
GetListPingProbeResultsSortOrderEnumValues Enumerates the set of values for ListPingProbeResultsSortOrderEnum
type PingMonitor ¶
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"` }
PingMonitor A summary containing all of the mutable and immutable properties for a ping monitor.
func (PingMonitor) String ¶
func (m PingMonitor) String() string
type PingMonitorProtocolEnum ¶
type PingMonitorProtocolEnum = PingProbeProtocolEnum
PingMonitorProtocolEnum is an alias to type: PingProbeProtocolEnum Consider using PingProbeProtocolEnum instead Deprecated
type PingMonitorSummary ¶
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"` }
PingMonitorSummary This model contains all of the mutable and immutable summary properties for an HTTP monitor.
func (PingMonitorSummary) String ¶
func (m PingMonitorSummary) String() string
type PingMonitorSummaryProtocolEnum ¶
type PingMonitorSummaryProtocolEnum = PingProbeProtocolEnum
PingMonitorSummaryProtocolEnum is an alias to type: PingProbeProtocolEnum Consider using PingProbeProtocolEnum instead Deprecated
type PingProbe ¶
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"` }
PingProbe This model contains all of the mutable and immutable properties for a ping probe.
type PingProbeProtocolEnum ¶
type PingProbeProtocolEnum string
PingProbeProtocolEnum Enum with underlying type: string
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 Deprecated
const ( PingProbeProtocolIcmp PingProbeProtocolEnum = "ICMP" PingProbeProtocolTcp PingProbeProtocolEnum = "TCP" )
Set of constants representing the allowable values for PingProbeProtocolEnum
const ( PingProbeResultSummaryProtocolIcmp PingProbeProtocolEnum = "ICMP" PingProbeResultSummaryProtocolTcp PingProbeProtocolEnum = "TCP" )
Set of constants representing the allowable values for PingProbeProtocolEnum Deprecated
const ( UpdatePingMonitorDetailsProtocolIcmp PingProbeProtocolEnum = "ICMP" UpdatePingMonitorDetailsProtocolTcp PingProbeProtocolEnum = "TCP" )
Set of constants representing the allowable values for PingProbeProtocolEnum Deprecated
func GetPingProbeProtocolEnumValues ¶
func GetPingProbeProtocolEnumValues() []PingProbeProtocolEnum
GetPingProbeProtocolEnumValues Enumerates the set of values for PingProbeProtocolEnum
type PingProbeResultSummary ¶
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"` }
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).
func (PingProbeResultSummary) String ¶
func (m PingProbeResultSummary) String() string
type PingProbeResultSummaryErrorCategoryEnum ¶
type PingProbeResultSummaryErrorCategoryEnum string
PingProbeResultSummaryErrorCategoryEnum Enum with underlying type: string
const ( PingProbeResultSummaryErrorCategoryNone PingProbeResultSummaryErrorCategoryEnum = "NONE" PingProbeResultSummaryErrorCategoryDns PingProbeResultSummaryErrorCategoryEnum = "DNS" PingProbeResultSummaryErrorCategoryTransport PingProbeResultSummaryErrorCategoryEnum = "TRANSPORT" PingProbeResultSummaryErrorCategoryNetwork PingProbeResultSummaryErrorCategoryEnum = "NETWORK" PingProbeResultSummaryErrorCategorySystem PingProbeResultSummaryErrorCategoryEnum = "SYSTEM" )
Set of constants representing the allowable values for PingProbeResultSummaryErrorCategoryEnum
func GetPingProbeResultSummaryErrorCategoryEnumValues ¶
func GetPingProbeResultSummaryErrorCategoryEnumValues() []PingProbeResultSummaryErrorCategoryEnum
GetPingProbeResultSummaryErrorCategoryEnumValues Enumerates the set of values for PingProbeResultSummaryErrorCategoryEnum
type PingProbeResultSummaryProtocolEnum ¶
type PingProbeResultSummaryProtocolEnum = PingProbeProtocolEnum
PingProbeResultSummaryProtocolEnum is an alias to type: PingProbeProtocolEnum Consider using PingProbeProtocolEnum instead Deprecated
type Routing ¶
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"` }
Routing The routing information for a vantage point.
type TcpConnection ¶
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"` }
TcpConnection TCP connection results. All durations are in milliseconds.
func (TcpConnection) String ¶
func (m TcpConnection) String() string
type UpdateHttpMonitorDetails ¶
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"` }
UpdateHttpMonitorDetails The request body used to update an HTTP monitor.
func (UpdateHttpMonitorDetails) String ¶
func (m UpdateHttpMonitorDetails) String() string
type UpdateHttpMonitorDetailsMethodEnum ¶
type UpdateHttpMonitorDetailsMethodEnum = HttpProbeMethodEnum
UpdateHttpMonitorDetailsMethodEnum is an alias to type: HttpProbeMethodEnum Consider using HttpProbeMethodEnum instead Deprecated
type UpdateHttpMonitorDetailsProtocolEnum ¶
type UpdateHttpMonitorDetailsProtocolEnum = HttpProbeProtocolEnum
UpdateHttpMonitorDetailsProtocolEnum is an alias to type: HttpProbeProtocolEnum Consider using HttpProbeProtocolEnum instead Deprecated
type 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 }
UpdateHttpMonitorRequest wrapper for the UpdateHttpMonitor operation
func (UpdateHttpMonitorRequest) HTTPRequest ¶
func (request UpdateHttpMonitorRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (UpdateHttpMonitorRequest) RetryPolicy ¶
func (request UpdateHttpMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (UpdateHttpMonitorRequest) String ¶
func (request UpdateHttpMonitorRequest) String() string
type UpdateHttpMonitorResponse ¶
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"` }
UpdateHttpMonitorResponse wrapper for the UpdateHttpMonitor operation
func (UpdateHttpMonitorResponse) HTTPResponse ¶
func (response UpdateHttpMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (UpdateHttpMonitorResponse) String ¶
func (response UpdateHttpMonitorResponse) String() string
type UpdatePingMonitorDetails ¶
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"` }
UpdatePingMonitorDetails The request body used to update a ping monitor.
func (UpdatePingMonitorDetails) String ¶
func (m UpdatePingMonitorDetails) String() string
type UpdatePingMonitorDetailsProtocolEnum ¶
type UpdatePingMonitorDetailsProtocolEnum = PingProbeProtocolEnum
UpdatePingMonitorDetailsProtocolEnum is an alias to type: PingProbeProtocolEnum Consider using PingProbeProtocolEnum instead Deprecated
type 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 }
UpdatePingMonitorRequest wrapper for the UpdatePingMonitor operation
func (UpdatePingMonitorRequest) HTTPRequest ¶
func (request UpdatePingMonitorRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (UpdatePingMonitorRequest) RetryPolicy ¶
func (request UpdatePingMonitorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (UpdatePingMonitorRequest) String ¶
func (request UpdatePingMonitorRequest) String() string
type UpdatePingMonitorResponse ¶
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"` }
UpdatePingMonitorResponse wrapper for the UpdatePingMonitor operation
func (UpdatePingMonitorResponse) HTTPResponse ¶
func (response UpdatePingMonitorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (UpdatePingMonitorResponse) String ¶
func (response UpdatePingMonitorResponse) String() string
Source Files ¶
- change_http_monitor_compartment_details.go
- change_http_monitor_compartment_request_response.go
- change_ping_monitor_compartment_details.go
- change_ping_monitor_compartment_request_response.go
- connection.go
- create_http_monitor_details.go
- create_http_monitor_request_response.go
- create_on_demand_http_probe_details.go
- create_on_demand_http_probe_request_response.go
- create_on_demand_ping_probe_details.go
- create_on_demand_ping_probe_request_response.go
- create_ping_monitor_details.go
- create_ping_monitor_request_response.go
- delete_http_monitor_request_response.go
- delete_ping_monitor_request_response.go
- dns.go
- geolocation.go
- get_http_monitor_request_response.go
- get_ping_monitor_request_response.go
- health_checks_vantage_point_summary.go
- healthchecks_client.go
- http_monitor.go
- http_monitor_summary.go
- http_probe.go
- http_probe_method.go
- http_probe_protocol.go
- http_probe_result_summary.go
- list_health_checks_vantage_points_request_response.go
- list_http_monitors_request_response.go
- list_http_probe_results_request_response.go
- list_ping_monitors_request_response.go
- list_ping_probe_results_request_response.go
- ping_monitor.go
- ping_monitor_summary.go
- ping_probe.go
- ping_probe_protocol.go
- ping_probe_result_summary.go
- routing.go
- tcp_connection.go
- update_http_monitor_details.go
- update_http_monitor_request_response.go
- update_ping_monitor_details.go
- update_ping_monitor_request_response.go