ocicontrolcenter

package
v65.42.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 27, 2023 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DimensionValue 

type DimensionValue struct {

	// The value of the dimension.
	DimensionValue *string `mandatory:"false" json:"dimensionValue"`
}

DimensionValue The dimension value for the given dimension name as key.

func (DimensionValue) String 

func (m DimensionValue) String() string

func (DimensionValue) ValidateEnumValue 

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

type 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
}

ListMetricPropertiesRequest wrapper for the ListMetricProperties operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocicontrolcenter/ListMetricProperties.go.html to see an example of how to use ListMetricPropertiesRequest.

func (ListMetricPropertiesRequest) BinaryRequestBody 

func (request ListMetricPropertiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListMetricPropertiesRequest) HTTPRequest 

func (request ListMetricPropertiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListMetricPropertiesRequest) RetryPolicy 

func (request ListMetricPropertiesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListMetricPropertiesRequest) String 

func (request ListMetricPropertiesRequest) String() string

func (ListMetricPropertiesRequest) ValidateEnumValue 

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

type ListMetricPropertiesResponse 

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"`
}

ListMetricPropertiesResponse wrapper for the ListMetricProperties operation

func (ListMetricPropertiesResponse) HTTPResponse 

func (response ListMetricPropertiesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListMetricPropertiesResponse) String 

func (response ListMetricPropertiesResponse) String() string

type 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
}

ListNamespacesRequest wrapper for the ListNamespaces operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocicontrolcenter/ListNamespaces.go.html to see an example of how to use ListNamespacesRequest.

func (ListNamespacesRequest) BinaryRequestBody 

func (request ListNamespacesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListNamespacesRequest) HTTPRequest 

func (request ListNamespacesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListNamespacesRequest) RetryPolicy 

func (request ListNamespacesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListNamespacesRequest) String 

func (request ListNamespacesRequest) String() string

func (ListNamespacesRequest) ValidateEnumValue 

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

type ListNamespacesResponse 

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"`
}

ListNamespacesResponse wrapper for the ListNamespaces operation

func (ListNamespacesResponse) HTTPResponse 

func (response ListNamespacesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListNamespacesResponse) String 

func (response ListNamespacesResponse) String() string

type MetricPropertyCollection 

type MetricPropertyCollection struct {

	// An array of MetricPropertySummary objects.
	Items []MetricPropertySummary `mandatory:"true" json:"items"`
}

MetricPropertyCollection A list of available metrics and their associated properties such as dimensions.

func (MetricPropertyCollection) String 

func (m MetricPropertyCollection) String() string

func (MetricPropertyCollection) ValidateEnumValue 

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

type MetricPropertySummary 

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"`
}

MetricPropertySummary A summary of the properties that define a metric.

func (MetricPropertySummary) String 

func (m MetricPropertySummary) String() string

func (MetricPropertySummary) ValidateEnumValue 

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

type NamespaceCollection 

type NamespaceCollection struct {

	// An array of NamespaceSummary objects.
	Items []NamespaceSummary `mandatory:"true" json:"items"`
}

NamespaceCollection The list of source services called namespaces emitting metrics that you can explore using OCI Control Center.

func (NamespaceCollection) String 

func (m NamespaceCollection) String() string

func (NamespaceCollection) ValidateEnumValue 

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

type NamespaceSummary 

type NamespaceSummary struct {

	// The name of the source service emitting the metric.
	NamespaceName *string `mandatory:"true" json:"namespaceName"`
}

NamespaceSummary A summary of the source service or application emitting the metric.

func (NamespaceSummary) String 

func (m NamespaceSummary) String() string

func (NamespaceSummary) ValidateEnumValue 

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

type OccMetricsClient 

type OccMetricsClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

OccMetricsClient a client for OccMetrics

func NewOccMetricsClientWithConfigurationProvider 

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 

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 (*OccMetricsClient) ConfigurationProvider 

func (client *OccMetricsClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (OccMetricsClient) ListMetricProperties 

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.

See also

Click https://docs.cloud.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 (OccMetricsClient) ListNamespaces 

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.

See also

Click https://docs.cloud.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 (OccMetricsClient) RequestSummarizedMetricData 

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.

See also

Click https://docs.cloud.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 (*OccMetricsClient) SetRegion 

func (client *OccMetricsClient) SetRegion(region string)

SetRegion overrides the region of this client.

type RequestSummarizedMetricDataDetails 

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"`
}

RequestSummarizedMetricDataDetails The request details for retrieving aggregated data. Use the query and optional properties to filter the returned results.

func (RequestSummarizedMetricDataDetails) String 

func (m RequestSummarizedMetricDataDetails) String() string

func (RequestSummarizedMetricDataDetails) ValidateEnumValue 

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

type 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
}

RequestSummarizedMetricDataRequest wrapper for the RequestSummarizedMetricData operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ocicontrolcenter/RequestSummarizedMetricData.go.html to see an example of how to use RequestSummarizedMetricDataRequest.

func (RequestSummarizedMetricDataRequest) BinaryRequestBody 

func (request RequestSummarizedMetricDataRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RequestSummarizedMetricDataRequest) HTTPRequest 

func (request RequestSummarizedMetricDataRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RequestSummarizedMetricDataRequest) RetryPolicy 

func (request RequestSummarizedMetricDataRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RequestSummarizedMetricDataRequest) String 

func (request RequestSummarizedMetricDataRequest) String() string

func (RequestSummarizedMetricDataRequest) ValidateEnumValue 

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

type RequestSummarizedMetricDataResponse 

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"`
}

RequestSummarizedMetricDataResponse wrapper for the RequestSummarizedMetricData operation

func (RequestSummarizedMetricDataResponse) HTTPResponse 

func (response RequestSummarizedMetricDataResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RequestSummarizedMetricDataResponse) String 

func (response RequestSummarizedMetricDataResponse) String() string

type SummarizedMetricData 

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"`
}

SummarizedMetricData The recorded metric value at a specific timestamp.

func (SummarizedMetricData) String 

func (m SummarizedMetricData) String() string

func (SummarizedMetricData) ValidateEnumValue 

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

type SummarizedMetricDataCollection 

type SummarizedMetricDataCollection struct {

	// An array of SummarizedMetricData items.
	Items []SummarizedMetricData `mandatory:"true" json:"items"`
}

SummarizedMetricDataCollection A list of aggregated metric data objects with properties.

func (SummarizedMetricDataCollection) String 

func (m SummarizedMetricDataCollection) String() string

func (SummarizedMetricDataCollection) ValidateEnumValue 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.