DimensionValue The dimension value for the given dimension name as key.
type DimensionValue struct {
// The value of the dimension.
DimensionValue *string `mandatory:"false" json:"dimensionValue"`
}
func (m DimensionValue) String() string
func (m DimensionValue) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListMetricPropertiesRequest wrapper for the ListMetricProperties operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocicontrolcenter/ListMetricProperties.go.html to see an example of how to use ListMetricPropertiesRequest.
type ListMetricPropertiesRequest struct {
// The name of the source service emitting the metric.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The OCID of the compartment to use for authorization. To use the root compartment, provide the tenancyId.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call.
// For important details about how pagination works, see <a href="https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine">List Pagination</a>.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListMetricPropertiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListMetricPropertiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListMetricPropertiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListMetricPropertiesRequest) String() string
func (request ListMetricPropertiesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListMetricPropertiesResponse wrapper for the ListMetricProperties operation
type ListMetricPropertiesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of MetricPropertyCollection instances
MetricPropertyCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this
// header appears in the response, then a partial list might have been
// returned. Include this value as the `page` parameter for the subsequent
// GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListMetricPropertiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListMetricPropertiesResponse) String() string
ListNamespacesRequest wrapper for the ListNamespaces operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocicontrolcenter/ListNamespaces.go.html to see an example of how to use ListNamespacesRequest.
type ListNamespacesRequest struct {
// The OCID of the compartment to use for authorization. To use the root compartment, provide the tenancyId.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call.
// For important details about how pagination works, see <a href="https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine">List Pagination</a>.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListNamespacesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListNamespacesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListNamespacesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListNamespacesRequest) String() string
func (request ListNamespacesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListNamespacesResponse wrapper for the ListNamespaces operation
type ListNamespacesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of NamespaceCollection instances
NamespaceCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this
// header appears in the response, then a partial list might have been
// returned. Include this value as the `page` parameter for the subsequent
// GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListNamespacesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListNamespacesResponse) String() string
MetricPropertyCollection A list of available metrics and their associated properties such as dimensions.
type MetricPropertyCollection struct {
// An array of MetricPropertySummary objects.
Items []MetricPropertySummary `mandatory:"true" json:"items"`
}
func (m MetricPropertyCollection) String() string
func (m MetricPropertyCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MetricPropertySummary A summary of the properties that define a metric.
type MetricPropertySummary struct {
// The name of the metric.
MetricName *string `mandatory:"true" json:"metricName"`
// Qualifiers provided in a metric definition. Available dimensions vary by metric namespace.
Dimensions map[string]DimensionValue `mandatory:"false" json:"dimensions"`
}
func (m MetricPropertySummary) String() string
func (m MetricPropertySummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NamespaceCollection The list of source services called namespaces emitting metrics that you can explore using OCI Control Center.
type NamespaceCollection struct {
// An array of NamespaceSummary objects.
Items []NamespaceSummary `mandatory:"true" json:"items"`
}
func (m NamespaceCollection) String() string
func (m NamespaceCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NamespaceSummary A summary of the source service or application emitting the metric.
type NamespaceSummary struct {
// The name of the source service emitting the metric.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
}
func (m NamespaceSummary) String() string
func (m NamespaceSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OccMetricsClient a client for OccMetrics
type OccMetricsClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewOccMetricsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OccMetricsClient, err error)
NewOccMetricsClientWithConfigurationProvider Creates a new default OccMetrics client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewOccMetricsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OccMetricsClient, err error)
NewOccMetricsClientWithOboToken Creates a new default OccMetrics client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *OccMetricsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client OccMetricsClient) ListMetricProperties(ctx context.Context, request ListMetricPropertiesRequest) (response ListMetricPropertiesResponse, err error)
ListMetricProperties Returns a list of available metrics for the given namespace. The results for metrics with dimensions includes list of all the associated dimensions. The results are sorted by the metricName and then by dimension in ascending alphabetical order. For a list of valid namespaces, see ListNamespaces.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocicontrolcenter/ListMetricProperties.go.html to see an example of how to use ListMetricProperties API. A default retry strategy applies to this operation ListMetricProperties()
func (client OccMetricsClient) ListNamespaces(ctx context.Context, request ListNamespacesRequest) (response ListNamespacesResponse, err error)
ListNamespaces List all the available source services called namespaces emitting metrics for this region. The namespaces are sorted in ascending alphabetical order.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocicontrolcenter/ListNamespaces.go.html to see an example of how to use ListNamespaces API. A default retry strategy applies to this operation ListNamespaces()
func (client OccMetricsClient) RequestSummarizedMetricData(ctx context.Context, request RequestSummarizedMetricDataRequest) (response RequestSummarizedMetricDataResponse, err error)
RequestSummarizedMetricData Returns the summarized data for the given metric from the given namespace. The aggregation method depends on the metric. The metric data can be filtered by providing the dimension, startTime or endTime. The metric data in the response is sorted by dimension in ascending order and then by sampleTime in ascending chronological order.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocicontrolcenter/RequestSummarizedMetricData.go.html to see an example of how to use RequestSummarizedMetricData API. A default retry strategy applies to this operation RequestSummarizedMetricData()
func (client *OccMetricsClient) SetRegion(region string)
SetRegion overrides the region of this client.
RequestSummarizedMetricDataDetails The request details for retrieving aggregated data. Use the query and optional properties to filter the returned results.
type RequestSummarizedMetricDataDetails struct {
// The source service or application to use when searching for metric data points to aggregate. For a list of valid namespaces, see ListNamespaces.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// The name of a metric for retrieving aggregated data. For a list of valid metrics for a given namespace, see ListMetricProperties.
MetricName *string `mandatory:"true" json:"metricName"`
// The OCID of the compartment to use for authorization to read metrics. To use the root compartment, provide the tenancyId.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Qualifiers to use when searching for metric data. For a list of valid dimensions for a given metric, see ListMetricProperties.
Dimensions map[string]DimensionValue `mandatory:"false" json:"dimensions"`
// The beginning of the sampled time range to use when searching for metric data points. Format is defined by <a href="https://www.rfc-editor.org/rfc/rfc3339">RFC3339</a>. The response includes metric data points for the sampled time. Example 2019-02-01T02:02:29.600Z
StartTime *common.SDKTime `mandatory:"false" json:"startTime"`
// The end of the sampled time range to use when searching for metric data points. Format is defined by <a href="https://www.rfc-editor.org/rfc/rfc3339">RFC3339</a>. The response excludes metric data points for sampled time. Example 2019-02-01T02:02:29.600Z
EndTime *common.SDKTime `mandatory:"false" json:"endTime"`
}
func (m RequestSummarizedMetricDataDetails) String() string
func (m RequestSummarizedMetricDataDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RequestSummarizedMetricDataRequest wrapper for the RequestSummarizedMetricData operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocicontrolcenter/RequestSummarizedMetricData.go.html to see an example of how to use RequestSummarizedMetricDataRequest.
type RequestSummarizedMetricDataRequest struct {
// Filters to apply to the metric data query
RequestSummarizedMetricDataDetails `contributesTo:"body"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call.
// For important details about how pagination works, see <a href="https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine">List Pagination</a>.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RequestSummarizedMetricDataRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RequestSummarizedMetricDataRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RequestSummarizedMetricDataRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RequestSummarizedMetricDataRequest) String() string
func (request RequestSummarizedMetricDataRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RequestSummarizedMetricDataResponse wrapper for the RequestSummarizedMetricData operation
type RequestSummarizedMetricDataResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SummarizedMetricDataCollection instances
SummarizedMetricDataCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this
// header appears in the response, then a partial list might have been
// returned. Include this value as the `page` parameter for the subsequent
// GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response RequestSummarizedMetricDataResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RequestSummarizedMetricDataResponse) String() string
SummarizedMetricData The recorded metric value at a specific timestamp.
type SummarizedMetricData struct {
// The time at which the metric data was recorded.
SampleTime *common.SDKTime `mandatory:"false" json:"sampleTime"`
// The duration over which the metric data is aggregated. Supported values: `1m`-`60m`, `1h`-`24h`, `1d`.
Resolution *string `mandatory:"false" json:"resolution"`
// Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace.
Dimensions map[string]DimensionValue `mandatory:"false" json:"dimensions"`
// The aggregation method used for aggregating the metric values. The aggregation method depends on the metric itself.
AggregationMethod *string `mandatory:"false" json:"aggregationMethod"`
// The aggregated metric value for the specified request.
AggregatedValue *float32 `mandatory:"false" json:"aggregatedValue"`
}
func (m SummarizedMetricData) String() string
func (m SummarizedMetricData) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SummarizedMetricDataCollection A list of aggregated metric data objects with properties.
type SummarizedMetricDataCollection struct {
// An array of SummarizedMetricData items.
Items []SummarizedMetricData `mandatory:"true" json:"items"`
}
func (m SummarizedMetricDataCollection) String() string
func (m SummarizedMetricDataCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly