func GetConfigTypesEnumStringValues() []string
GetConfigTypesEnumStringValues Enumerates the set of values in String for ConfigTypesEnum
func GetListConfigsSortByEnumStringValues() []string
GetListConfigsSortByEnumStringValues Enumerates the set of values in String for ListConfigsSortByEnum
func GetListConfigsSortOrderEnumStringValues() []string
GetListConfigsSortOrderEnumStringValues Enumerates the set of values in String for ListConfigsSortOrderEnum
func GetMetricTypesEnumStringValues() []string
GetMetricTypesEnumStringValues Enumerates the set of values in String for MetricTypesEnum
func GetSortOrdersEnumStringValues() []string
GetSortOrdersEnumStringValues Enumerates the set of values in String for SortOrdersEnum
Apdex An Apdex configuration rule. The Apdex score is computed based on how the response time of a span compares to two predefined threshold values. The first threshold defines the maximum response time that is considered satisfactory for the end user. The second one defines the maximum response time that is considered tolerable. All times larger than that will be considered frustrating for the end user. An Apdex configuration rule works by selecting a subset of spans based on a filter expression and applying the two threshold comparisons to compute a score for each of the selected spans. The rule has an "isApplyToErrorSpans" property that controls whether or not to compute the Apdex for spans that have been marked as errors. If this property is set to "true", then the Apdex score for error spans is computed in the same way as for non-error ones. If set to "false", then computation for error spans is skipped, and the score is set to "frustrating" regardless of the configured thresholds. The default is "false". The "isEnabled" property controls whether or not an Apdex score is computed and can be used to disable Apdex score for certain spans. The default is "true". The "priority" property specifies the importance of the rule within a rule set. Lower values indicate a higher priority. Rules with higher priorities are evaluated first in the rule set. The priority of the rules must be unique within a rule set.
type Apdex struct {
// The string that defines the Span Filter expression.
FilterText *string `mandatory:"true" json:"filterText"`
// The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher
// priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are
// ignored. Rules within the same rule set cannot have the same priority.
Priority *int `mandatory:"true" json:"priority"`
// Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable
// Apdex score for spans that do not need or require it. The default is "true".
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// The maximum response time in milliseconds that is considered "satisfactory" for the end user.
SatisfiedResponseTime *int `mandatory:"false" json:"satisfiedResponseTime"`
// The maximum response time in milliseconds that is considered "tolerable" for the end user. A response
// time beyond this threshold is considered "frustrating".
// This value cannot be lower than "satisfiedResponseTime".
ToleratingResponseTime *int `mandatory:"false" json:"toleratingResponseTime"`
// Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex
// score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex
// score to "frustrating" regardless of the configured thresholds. The default is "false".
IsApplyToErrorSpans *bool `mandatory:"false" json:"isApplyToErrorSpans"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m Apdex) String() string
func (m Apdex) 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
ApdexRules The set of Apdex rules to be used in Apdex computation. In the current version, only one rule set can exist in the configuration.
type ApdexRules struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated
// when the item is created.
Id *string `mandatory:"false" json:"id"`
// The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-13T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
// For optimistic concurrency control. See `if-match`.
Etag *string `mandatory:"false" json:"etag"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
Rules []Apdex `mandatory:"false" json:"rules"`
}
func (m ApdexRules) GetCreatedBy() *string
GetCreatedBy returns CreatedBy
func (m ApdexRules) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ApdexRules) GetEtag() *string
GetEtag returns Etag
func (m ApdexRules) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ApdexRules) GetId() *string
GetId returns Id
func (m ApdexRules) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ApdexRules) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ApdexRules) GetUpdatedBy() *string
GetUpdatedBy returns UpdatedBy
func (m ApdexRules) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ApdexRules) String() string
func (m ApdexRules) 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
ApdexRulesSummary The set of Apdex rules used in Apdex computation.
type ApdexRulesSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated
// when the item is created.
Id *string `mandatory:"false" json:"id"`
// The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-13T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
// For optimistic concurrency control. See `if-match`.
Etag *string `mandatory:"false" json:"etag"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
Rules []Apdex `mandatory:"false" json:"rules"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m ApdexRulesSummary) GetCreatedBy() *string
GetCreatedBy returns CreatedBy
func (m ApdexRulesSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ApdexRulesSummary) GetEtag() *string
GetEtag returns Etag
func (m ApdexRulesSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ApdexRulesSummary) GetId() *string
GetId returns Id
func (m ApdexRulesSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ApdexRulesSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ApdexRulesSummary) GetUpdatedBy() *string
GetUpdatedBy returns UpdatedBy
func (m ApdexRulesSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ApdexRulesSummary) String() string
func (m ApdexRulesSummary) 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
Config A configuration item, which has a number of mutually exclusive properties that can be used to set specific portions of the configuration.
type Config interface {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated
// when the item is created.
GetId() *string
// The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-12T22:47:12.613Z`
GetTimeCreated() *common.SDKTime
// The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-13T22:47:12.613Z`
GetTimeUpdated() *common.SDKTime
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
GetCreatedBy() *string
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
GetUpdatedBy() *string
// For optimistic concurrency control. See `if-match`.
GetEtag() *string
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
ConfigClient a client for Config
type ConfigClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewConfigClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ConfigClient, err error)
NewConfigClientWithConfigurationProvider Creates a new default Config client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewConfigClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ConfigClient, err error)
NewConfigClientWithOboToken Creates a new default Config 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 *ConfigClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ConfigClient) CreateConfig(ctx context.Context, request CreateConfigRequest) (response CreateConfigResponse, err error)
CreateConfig Creates a new configuration item.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/CreateConfig.go.html to see an example of how to use CreateConfig API. A default retry strategy applies to this operation CreateConfig()
func (client ConfigClient) DeleteConfig(ctx context.Context, request DeleteConfigRequest) (response DeleteConfigResponse, err error)
DeleteConfig Deletes the configuration item identified by the OCID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/DeleteConfig.go.html to see an example of how to use DeleteConfig API. A default retry strategy applies to this operation DeleteConfig()
func (client ConfigClient) GetConfig(ctx context.Context, request GetConfigRequest) (response GetConfigResponse, err error)
GetConfig Gets the configuration item identified by the OCID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/GetConfig.go.html to see an example of how to use GetConfig API. A default retry strategy applies to this operation GetConfig()
func (client ConfigClient) ListConfigs(ctx context.Context, request ListConfigsRequest) (response ListConfigsResponse, err error)
ListConfigs Returns all configuration items, which can optionally be filtered by configuration type.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/ListConfigs.go.html to see an example of how to use ListConfigs API. A default retry strategy applies to this operation ListConfigs()
func (client ConfigClient) RetrieveNamespaceMetrics(ctx context.Context, request RetrieveNamespaceMetricsRequest) (response RetrieveNamespaceMetricsResponse, err error)
RetrieveNamespaceMetrics Returns all metrics associated with the specified namespace.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/RetrieveNamespaceMetrics.go.html to see an example of how to use RetrieveNamespaceMetrics API. A default retry strategy applies to this operation RetrieveNamespaceMetrics()
func (client ConfigClient) RetrieveNamespaces(ctx context.Context, request RetrieveNamespacesRequest) (response RetrieveNamespacesResponse, err error)
RetrieveNamespaces Returns all namespaces available in APM.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/RetrieveNamespaces.go.html to see an example of how to use RetrieveNamespaces API. A default retry strategy applies to this operation RetrieveNamespaces()
func (client *ConfigClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ConfigClient) UpdateConfig(ctx context.Context, request UpdateConfigRequest) (response UpdateConfigResponse, err error)
UpdateConfig Updates the details of the configuration item identified by the OCID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/UpdateConfig.go.html to see an example of how to use UpdateConfig API. A default retry strategy applies to this operation UpdateConfig()
func (client ConfigClient) ValidateSpanFilterPattern(ctx context.Context, request ValidateSpanFilterPatternRequest) (response ValidateSpanFilterPatternResponse, err error)
ValidateSpanFilterPattern Validates the Span Filter pattern (filterText) for syntactic correctness. Returns 204 on success, 422 when validation fails.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/ValidateSpanFilterPattern.go.html to see an example of how to use ValidateSpanFilterPattern API. A default retry strategy applies to this operation ValidateSpanFilterPattern()
ConfigCollection A collection of configuration items.
type ConfigCollection struct {
Items []ConfigSummary `mandatory:"true" json:"items"`
}
func (m ConfigCollection) String() string
func (m *ConfigCollection) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ConfigCollection) 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
ConfigSummary A description of a configuration item. It specifies all the properties that define the configuration item.
type ConfigSummary interface {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated
// when the item is created.
GetId() *string
// The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-12T22:47:12.613Z`
GetTimeCreated() *common.SDKTime
// The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-13T22:47:12.613Z`
GetTimeUpdated() *common.SDKTime
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
GetCreatedBy() *string
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
GetUpdatedBy() *string
// For optimistic concurrency control. See `if-match`.
GetEtag() *string
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
ConfigTypesEnum Enum with underlying type: string
type ConfigTypesEnum string
Set of constants representing the allowable values for ConfigTypesEnum
const (
ConfigTypesSpanFilter ConfigTypesEnum = "SPAN_FILTER"
ConfigTypesMetricGroup ConfigTypesEnum = "METRIC_GROUP"
ConfigTypesApdex ConfigTypesEnum = "APDEX"
ConfigTypesOptions ConfigTypesEnum = "OPTIONS"
)
func GetConfigTypesEnumValues() []ConfigTypesEnum
GetConfigTypesEnumValues Enumerates the set of values for ConfigTypesEnum
func GetMappingConfigTypesEnum(val string) (ConfigTypesEnum, bool)
GetMappingConfigTypesEnum performs case Insensitive comparison on enum value and return the desired enum
CreateApdexRulesDetails The set of Apdex rules to be used in Apdex computation. In the current version, only one rule set may exist per configuration, and attempting to create a rule set if it already exists results in an error.
type CreateApdexRulesDetails struct {
Rules []Apdex `mandatory:"true" json:"rules"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"true" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateApdexRulesDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateApdexRulesDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateApdexRulesDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateApdexRulesDetails) String() string
func (m CreateApdexRulesDetails) 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
CreateConfigDetails The request body used to create new configuration items. It must specify the configuration type of the item, as well as the actual data to populate the item with.
type CreateConfigDetails interface {
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
CreateConfigRequest wrapper for the CreateConfig operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/CreateConfig.go.html to see an example of how to use CreateConfigRequest.
type CreateConfigRequest struct {
// The APM Domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// The configuration details of the new item.
CreateConfigDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique 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"`
// Indicates that the request is a dry run, if set to "true". A dry run request does not modify the
// configuration item details and is used only to perform validation on the submitted data.
OpcDryRun *string `mandatory:"false" contributesTo:"header" name:"opc-dry-run"`
// 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 CreateConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateConfigRequest) String() string
func (request CreateConfigRequest) 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
CreateConfigResponse wrapper for the CreateConfig operation
type CreateConfigResponse struct {
// The underlying http response
RawResponse *http.Response
// The Config instance
Config `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateConfigResponse) String() string
CreateMetricGroupDetails A metric group defines a set of metrics to collect from a span. It uses a span filter to specify which spans to process. The set is then published to a namespace, which is a product level subdivision of metrics.
type CreateMetricGroupDetails struct {
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a Span Filter. The filterId is mandatory for the creation
// of MetricGroups. A filterId is generated when a Span Filter is created.
FilterId *string `mandatory:"true" json:"filterId"`
// The list of metrics in this group.
Metrics []Metric `mandatory:"true" json:"metrics"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The namespace to which the metrics are published. It must be one of several predefined namespaces.
Namespace *string `mandatory:"false" json:"namespace"`
// A list of dimensions for the metric. This variable should not be used.
Dimensions []Dimension `mandatory:"false" json:"dimensions"`
}
func (m CreateMetricGroupDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateMetricGroupDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateMetricGroupDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateMetricGroupDetails) String() string
func (m CreateMetricGroupDetails) 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
CreateOptionsDetails An Options object represents configuration options.
type CreateOptionsDetails struct {
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
// The options are stored here as JSON.
Options *interface{} `mandatory:"false" json:"options"`
// A string that specifies the group that an OPTIONS item belongs to.
Group *string `mandatory:"false" json:"group"`
// An optional string that describes what the options are intended or used for.
Description *string `mandatory:"false" json:"description"`
}
func (m CreateOptionsDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateOptionsDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateOptionsDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateOptionsDetails) String() string
func (m CreateOptionsDetails) 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
CreateSpanFilterDetails A named setting that specifies the filter criteria to match a subset of the spans.
type CreateSpanFilterDetails struct {
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"true" json:"displayName"`
// The string that defines the Span Filter expression.
FilterText *string `mandatory:"true" json:"filterText"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// An optional string that describes what the filter is intended or used for.
Description *string `mandatory:"false" json:"description"`
}
func (m CreateSpanFilterDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateSpanFilterDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateSpanFilterDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateSpanFilterDetails) String() string
func (m CreateSpanFilterDetails) 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
DeleteConfigRequest wrapper for the DeleteConfig operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/DeleteConfig.go.html to see an example of how to use DeleteConfigRequest.
type DeleteConfigRequest struct {
// The APM Domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item.
ConfigId *string `mandatory:"true" contributesTo:"path" name:"configId"`
// 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 identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteConfigRequest) String() string
func (request DeleteConfigRequest) 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
DeleteConfigResponse wrapper for the DeleteConfig operation
type DeleteConfigResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteConfigResponse) String() string
Dimension A dimension is a label that is used to describe or group metrics.
type Dimension struct {
// The name of the dimension.
Name *string `mandatory:"true" json:"name"`
// The source to populate the dimension. This must not be specified.
ValueSource *string `mandatory:"false" json:"valueSource"`
}
func (m Dimension) String() string
func (m Dimension) 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
GetConfigRequest wrapper for the GetConfig operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/GetConfig.go.html to see an example of how to use GetConfigRequest.
type GetConfigRequest struct {
// The APM Domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item.
ConfigId *string `mandatory:"true" contributesTo:"path" name:"configId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetConfigRequest) String() string
func (request GetConfigRequest) 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
GetConfigResponse wrapper for the GetConfig operation
type GetConfigResponse struct {
// The underlying http response
RawResponse *http.Response
// The Config instance
Config `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetConfigResponse) String() string
ListConfigsRequest wrapper for the ListConfigs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/ListConfigs.go.html to see an example of how to use ListConfigsRequest.
type ListConfigsRequest struct {
// The APM Domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// Unique 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 filter to match configuration items of a given type.
// Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
ConfigType *string `mandatory:"false" contributesTo:"query" name:"configType"`
// A filter to return resources that match the given display name.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The maximum number of results per page, or items to return in a paginated "List" call. For information on
// how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `50`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The displayName sort order
// is case-sensitive.
SortOrder ListConfigsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one "sortBy" value. The default order for displayName, timeCreated
// and timeUpdated is ascending. The displayName sort by is case-sensitive.
SortBy ListConfigsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A filter to return OPTIONS resources that match the given group.
OptionsGroup *string `mandatory:"false" contributesTo:"query" name:"optionsGroup"`
// A list of tag filters to apply. Only resources with a defined tag matching the value will be returned.
// Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive.
// Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR".
// Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
DefinedTagEquals []string `contributesTo:"query" name:"definedTagEquals" collectionFormat:"multi"`
// A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned.
// The key for each tag is "{tagName}.{value}". All inputs are case-insensitive.
// Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
FreeformTagEquals []string `contributesTo:"query" name:"freeformTagEquals" collectionFormat:"multi"`
// A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned.
// Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag)
// or "{namespace}.true". All inputs are case-insensitive.
// Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported.
// Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR".
// Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
DefinedTagExists []string `contributesTo:"query" name:"definedTagExists" collectionFormat:"multi"`
// A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned.
// The key for each tag is "{tagName}.true". All inputs are case-insensitive.
// Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported.
// Multiple values for different tag names are interpreted as "AND".
FreeformTagExists []string `contributesTo:"query" name:"freeformTagExists" collectionFormat:"multi"`
// 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 ListConfigsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListConfigsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListConfigsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListConfigsRequest) String() string
func (request ListConfigsRequest) 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
ListConfigsResponse wrapper for the ListConfigs operation
type ListConfigsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ConfigCollection instances
ConfigCollection `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 ListConfigsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListConfigsResponse) String() string
ListConfigsSortByEnum Enum with underlying type: string
type ListConfigsSortByEnum string
Set of constants representing the allowable values for ListConfigsSortByEnum
const (
ListConfigsSortByDisplayname ListConfigsSortByEnum = "displayName"
ListConfigsSortByTimecreated ListConfigsSortByEnum = "timeCreated"
ListConfigsSortByTimeupdated ListConfigsSortByEnum = "timeUpdated"
)
func GetListConfigsSortByEnumValues() []ListConfigsSortByEnum
GetListConfigsSortByEnumValues Enumerates the set of values for ListConfigsSortByEnum
func GetMappingListConfigsSortByEnum(val string) (ListConfigsSortByEnum, bool)
GetMappingListConfigsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListConfigsSortOrderEnum Enum with underlying type: string
type ListConfigsSortOrderEnum string
Set of constants representing the allowable values for ListConfigsSortOrderEnum
const (
ListConfigsSortOrderAsc ListConfigsSortOrderEnum = "ASC"
ListConfigsSortOrderDesc ListConfigsSortOrderEnum = "DESC"
)
func GetListConfigsSortOrderEnumValues() []ListConfigsSortOrderEnum
GetListConfigsSortOrderEnumValues Enumerates the set of values for ListConfigsSortOrderEnum
func GetMappingListConfigsSortOrderEnum(val string) (ListConfigsSortOrderEnum, bool)
GetMappingListConfigsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
Metric A metric is a quantitative measurement of an entity.
type Metric struct {
// The name of the metric. This must be a known metric name.
Name *string `mandatory:"true" json:"name"`
// This must not be set.
ValueSource *string `mandatory:"false" json:"valueSource"`
// The unit of the metric.
Unit *string `mandatory:"false" json:"unit"`
// A description of the metric.
Description *string `mandatory:"false" json:"description"`
}
func (m Metric) String() string
func (m Metric) 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
MetricGroup A metric group defines a set of metrics to collect from a span. It uses a span filter to specify which spans to process. The set is then published to a namespace, which is a product level subdivision of metrics.
type MetricGroup struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated
// when the item is created.
Id *string `mandatory:"false" json:"id"`
// The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-13T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
// For optimistic concurrency control. See `if-match`.
Etag *string `mandatory:"false" json:"etag"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a Span Filter. The filterId is mandatory for the creation
// of MetricGroups. A filterId is generated when a Span Filter is created.
FilterId *string `mandatory:"false" json:"filterId"`
// The namespace to which the metrics are published. It must be one of several predefined namespaces.
Namespace *string `mandatory:"false" json:"namespace"`
// A list of dimensions for the metric. This variable should not be used.
Dimensions []Dimension `mandatory:"false" json:"dimensions"`
// The list of metrics in this group.
Metrics []Metric `mandatory:"false" json:"metrics"`
}
func (m MetricGroup) GetCreatedBy() *string
GetCreatedBy returns CreatedBy
func (m MetricGroup) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m MetricGroup) GetEtag() *string
GetEtag returns Etag
func (m MetricGroup) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m MetricGroup) GetId() *string
GetId returns Id
func (m MetricGroup) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m MetricGroup) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m MetricGroup) GetUpdatedBy() *string
GetUpdatedBy returns UpdatedBy
func (m MetricGroup) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MetricGroup) String() string
func (m MetricGroup) 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
MetricGroupSummary A metric group defines a set of metrics to collect from a span. It uses a span filter to specify which spans to process. The set is then published to a namespace, which is a product level subdivision of metrics.
type MetricGroupSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated
// when the item is created.
Id *string `mandatory:"false" json:"id"`
// The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-13T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
// For optimistic concurrency control. See `if-match`.
Etag *string `mandatory:"false" json:"etag"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a Span Filter. The filterId is mandatory for the creation
// of MetricGroups. A filterId is generated when a Span Filter is created.
FilterId *string `mandatory:"false" json:"filterId"`
// The namespace to which the metrics are published. It must be one of several predefined namespaces.
Namespace *string `mandatory:"false" json:"namespace"`
// A list of dimensions for the metric. This variable should not be used.
Dimensions []Dimension `mandatory:"false" json:"dimensions"`
// The list of metrics in this group.
Metrics []Metric `mandatory:"false" json:"metrics"`
}
func (m MetricGroupSummary) GetCreatedBy() *string
GetCreatedBy returns CreatedBy
func (m MetricGroupSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m MetricGroupSummary) GetEtag() *string
GetEtag returns Etag
func (m MetricGroupSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m MetricGroupSummary) GetId() *string
GetId returns Id
func (m MetricGroupSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m MetricGroupSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m MetricGroupSummary) GetUpdatedBy() *string
GetUpdatedBy returns UpdatedBy
func (m MetricGroupSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MetricGroupSummary) String() string
func (m MetricGroupSummary) 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
MetricTypesEnum Enum with underlying type: string
type MetricTypesEnum string
Set of constants representing the allowable values for MetricTypesEnum
const (
MetricTypesCounter MetricTypesEnum = "COUNTER"
MetricTypesGauge MetricTypesEnum = "GAUGE"
)
func GetMappingMetricTypesEnum(val string) (MetricTypesEnum, bool)
GetMappingMetricTypesEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMetricTypesEnumValues() []MetricTypesEnum
GetMetricTypesEnumValues Enumerates the set of values for MetricTypesEnum
Namespace Namespaces represent a product level subdivision by name.
type Namespace struct {
// Name of the namespace.
Name *string `mandatory:"true" json:"name"`
}
func (m Namespace) String() string
func (m Namespace) 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 Collection of available namespaces.
type NamespaceCollection struct {
// The list of available namespaces.
Items []Namespace `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
NamespaceMetric Metric associated with a namespace.
type NamespaceMetric struct {
// Name of the metric.
Name *string `mandatory:"true" json:"name"`
// Type of metric.
Type MetricTypesEnum `mandatory:"true" json:"type"`
// Unit of the metric.
Unit *string `mandatory:"false" json:"unit"`
}
func (m NamespaceMetric) String() string
func (m NamespaceMetric) 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
NamespaceMetricCollection Collection of available namespace metrics.
type NamespaceMetricCollection struct {
// The list of available namespace metrics.
Items []NamespaceMetric `mandatory:"true" json:"items"`
}
func (m NamespaceMetricCollection) String() string
func (m NamespaceMetricCollection) 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
Options An object that represents configuration options.
type Options struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated
// when the item is created.
Id *string `mandatory:"false" json:"id"`
// The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-13T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
// For optimistic concurrency control. See `if-match`.
Etag *string `mandatory:"false" json:"etag"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
// The options are stored here as JSON.
Options *interface{} `mandatory:"false" json:"options"`
// A string that specifies the group that an OPTIONS item belongs to.
Group *string `mandatory:"false" json:"group"`
// An optional string that describes what the options are intended or used for.
Description *string `mandatory:"false" json:"description"`
}
func (m Options) GetCreatedBy() *string
GetCreatedBy returns CreatedBy
func (m Options) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m Options) GetEtag() *string
GetEtag returns Etag
func (m Options) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m Options) GetId() *string
GetId returns Id
func (m Options) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m Options) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m Options) GetUpdatedBy() *string
GetUpdatedBy returns UpdatedBy
func (m Options) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m Options) String() string
func (m Options) 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
OptionsSummary An Options object represents configuration options.
type OptionsSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated
// when the item is created.
Id *string `mandatory:"false" json:"id"`
// The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-13T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
// For optimistic concurrency control. See `if-match`.
Etag *string `mandatory:"false" json:"etag"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
// The options are stored here as JSON.
Options *interface{} `mandatory:"false" json:"options"`
// A string that specifies the group that an OPTIONS item belongs to.
Group *string `mandatory:"false" json:"group"`
// An optional string that describes what the options are intended or used for.
Description *string `mandatory:"false" json:"description"`
}
func (m OptionsSummary) GetCreatedBy() *string
GetCreatedBy returns CreatedBy
func (m OptionsSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m OptionsSummary) GetEtag() *string
GetEtag returns Etag
func (m OptionsSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m OptionsSummary) GetId() *string
GetId returns Id
func (m OptionsSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m OptionsSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m OptionsSummary) GetUpdatedBy() *string
GetUpdatedBy returns UpdatedBy
func (m OptionsSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OptionsSummary) String() string
func (m OptionsSummary) 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
RetrieveNamespaceMetricsDetails The request body used to retrieve metrics for the specified namespace.
type RetrieveNamespaceMetricsDetails struct {
// Name of the namespace.
Name *string `mandatory:"true" json:"name"`
}
func (m RetrieveNamespaceMetricsDetails) String() string
func (m RetrieveNamespaceMetricsDetails) 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
RetrieveNamespaceMetricsRequest wrapper for the RetrieveNamespaceMetrics operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/RetrieveNamespaceMetrics.go.html to see an example of how to use RetrieveNamespaceMetricsRequest.
type RetrieveNamespaceMetricsRequest struct {
// The APM Domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// The namespace to get the metrics for.
RetrieveNamespaceMetricsDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RetrieveNamespaceMetricsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetrieveNamespaceMetricsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetrieveNamespaceMetricsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetrieveNamespaceMetricsRequest) String() string
func (request RetrieveNamespaceMetricsRequest) 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
RetrieveNamespaceMetricsResponse wrapper for the RetrieveNamespaceMetrics operation
type RetrieveNamespaceMetricsResponse struct {
// The underlying http response
RawResponse *http.Response
// The NamespaceMetricCollection instance
NamespaceMetricCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response RetrieveNamespaceMetricsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetrieveNamespaceMetricsResponse) String() string
RetrieveNamespacesRequest wrapper for the RetrieveNamespaces operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/RetrieveNamespaces.go.html to see an example of how to use RetrieveNamespacesRequest.
type RetrieveNamespacesRequest struct {
// The APM Domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RetrieveNamespacesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetrieveNamespacesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetrieveNamespacesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetrieveNamespacesRequest) String() string
func (request RetrieveNamespacesRequest) 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
RetrieveNamespacesResponse wrapper for the RetrieveNamespaces operation
type RetrieveNamespacesResponse struct {
// The underlying http response
RawResponse *http.Response
// The NamespaceCollection instance
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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response RetrieveNamespacesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetrieveNamespacesResponse) String() string
SortOrdersEnum Enum with underlying type: string
type SortOrdersEnum string
Set of constants representing the allowable values for SortOrdersEnum
const (
SortOrdersAsc SortOrdersEnum = "ASC"
SortOrdersDesc SortOrdersEnum = "DESC"
)
func GetMappingSortOrdersEnum(val string) (SortOrdersEnum, bool)
GetMappingSortOrdersEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrdersEnumValues() []SortOrdersEnum
GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum
SpanFilter A named setting that specifies the filter criteria to match a subset of the spans.
type SpanFilter struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated
// when the item is created.
Id *string `mandatory:"false" json:"id"`
// The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-13T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
// For optimistic concurrency control. See `if-match`.
Etag *string `mandatory:"false" json:"etag"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
// The string that defines the Span Filter expression.
FilterText *string `mandatory:"false" json:"filterText"`
// The list of configuration items that reference the span filter.
InUseBy []SpanFilterReference `mandatory:"false" json:"inUseBy"`
// An optional string that describes what the span filter is intended or used for.
Description *string `mandatory:"false" json:"description"`
}
func (m SpanFilter) GetCreatedBy() *string
GetCreatedBy returns CreatedBy
func (m SpanFilter) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m SpanFilter) GetEtag() *string
GetEtag returns Etag
func (m SpanFilter) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m SpanFilter) GetId() *string
GetId returns Id
func (m SpanFilter) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m SpanFilter) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m SpanFilter) GetUpdatedBy() *string
GetUpdatedBy returns UpdatedBy
func (m SpanFilter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SpanFilter) String() string
func (m SpanFilter) 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
SpanFilterReference Describes an item that references the span filter.
type SpanFilterReference struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated
// when the item is created.
Id *string `mandatory:"false" json:"id"`
// The type of configuration item.
ConfigType ConfigTypesEnum `mandatory:"false" json:"configType,omitempty"`
// A string that specifies the group that an OPTIONS item belongs to.
OptionsGroup *string `mandatory:"false" json:"optionsGroup"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m SpanFilterReference) String() string
func (m SpanFilterReference) 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
SpanFilterSummary A named setting that specifies the span filter criteria to match a subset of the spans.
type SpanFilterSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated
// when the item is created.
Id *string `mandatory:"false" json:"id"`
// The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-13T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a user.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
// For optimistic concurrency control. See `if-match`.
Etag *string `mandatory:"false" json:"etag"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
// The string that defines the Span Filter expression.
FilterText *string `mandatory:"false" json:"filterText"`
// The list of configuration items that reference the span filter.
InUseBy []SpanFilterReference `mandatory:"false" json:"inUseBy"`
// An optional string that describes what the filter is intended or used for.
Description *string `mandatory:"false" json:"description"`
}
func (m SpanFilterSummary) GetCreatedBy() *string
GetCreatedBy returns CreatedBy
func (m SpanFilterSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m SpanFilterSummary) GetEtag() *string
GetEtag returns Etag
func (m SpanFilterSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m SpanFilterSummary) GetId() *string
GetId returns Id
func (m SpanFilterSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m SpanFilterSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m SpanFilterSummary) GetUpdatedBy() *string
GetUpdatedBy returns UpdatedBy
func (m SpanFilterSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SpanFilterSummary) String() string
func (m SpanFilterSummary) 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
UpdateApdexRulesDetails The set of Apdex rules to be used in Apdex computation.
type UpdateApdexRulesDetails struct {
Rules []Apdex `mandatory:"true" json:"rules"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m UpdateApdexRulesDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateApdexRulesDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateApdexRulesDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateApdexRulesDetails) String() string
func (m UpdateApdexRulesDetails) 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
UpdateConfigDetails The request body used to update the configuration item. It must specify the data to update the item with.
type UpdateConfigDetails interface {
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
UpdateConfigRequest wrapper for the UpdateConfig operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/UpdateConfig.go.html to see an example of how to use UpdateConfigRequest.
type UpdateConfigRequest struct {
// The APM Domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration item.
ConfigId *string `mandatory:"true" contributesTo:"path" name:"configId"`
// The configuration details to be updated.
UpdateConfigDetails `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 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"`
// Indicates that the request is a dry run, if set to "true". A dry run request does not modify the
// configuration item details and is used only to perform validation on the submitted data.
OpcDryRun *string `mandatory:"false" contributesTo:"header" name:"opc-dry-run"`
// 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 UpdateConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateConfigRequest) String() string
func (request UpdateConfigRequest) 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
UpdateConfigResponse wrapper for the UpdateConfig operation
type UpdateConfigResponse struct {
// The underlying http response
RawResponse *http.Response
// The Config instance
Config `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateConfigResponse) String() string
UpdateMetricGroupDetails A metric group defines a set of metrics to collect from a span. It uses a span filter to specify which spans to process. The set is then published to a namespace, which is a product level subdivision of metrics.
type UpdateMetricGroupDetails struct {
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a Span Filter. The filterId is mandatory for the creation
// of MetricGroups. A filterId is generated when a Span Filter is created.
FilterId *string `mandatory:"false" json:"filterId"`
// The namespace to which the metrics are published. It must be one of several predefined namespaces.
Namespace *string `mandatory:"false" json:"namespace"`
// A list of dimensions for the metric. This variable should not be used.
Dimensions []Dimension `mandatory:"false" json:"dimensions"`
// The list of metrics in this group.
Metrics []Metric `mandatory:"false" json:"metrics"`
}
func (m UpdateMetricGroupDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateMetricGroupDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateMetricGroupDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateMetricGroupDetails) String() string
func (m UpdateMetricGroupDetails) 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
UpdateOptionsDetails An Options object represents configuration options.
type UpdateOptionsDetails struct {
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
// The options are stored here as JSON.
Options *interface{} `mandatory:"false" json:"options"`
// A string that specifies the group that an OPTIONS item belongs to.
Group *string `mandatory:"false" json:"group"`
// An optional string that describes what the options are intended or used for.
Description *string `mandatory:"false" json:"description"`
}
func (m UpdateOptionsDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateOptionsDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateOptionsDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateOptionsDetails) String() string
func (m UpdateOptionsDetails) 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
UpdateSpanFilterDetails A named setting that specifies the filter criteria to match a subset of the spans.
type UpdateSpanFilterDetails struct {
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The name by which a configuration entity is displayed to the end user.
DisplayName *string `mandatory:"false" json:"displayName"`
// The string that defines the Span Filter expression.
FilterText *string `mandatory:"false" json:"filterText"`
// An optional string that describes what the filter is intended or used for.
Description *string `mandatory:"false" json:"description"`
}
func (m UpdateSpanFilterDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateSpanFilterDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateSpanFilterDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateSpanFilterDetails) String() string
func (m UpdateSpanFilterDetails) 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
ValidateSpanFilterPatternDetails The request body used to validate a Span Filter pattern.
type ValidateSpanFilterPatternDetails struct {
// The string that defines the Span Filter expression.
FilterText *string `mandatory:"true" json:"filterText"`
}
func (m ValidateSpanFilterPatternDetails) String() string
func (m ValidateSpanFilterPatternDetails) 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
ValidateSpanFilterPatternRequest wrapper for the ValidateSpanFilterPattern operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/apmconfig/ValidateSpanFilterPattern.go.html to see an example of how to use ValidateSpanFilterPatternRequest.
type ValidateSpanFilterPatternRequest struct {
// The APM Domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// The Span Filter pattern to validate.
ValidateSpanFilterPatternDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ValidateSpanFilterPatternRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ValidateSpanFilterPatternRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ValidateSpanFilterPatternRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ValidateSpanFilterPatternRequest) String() string
func (request ValidateSpanFilterPatternRequest) 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
ValidateSpanFilterPatternResponse wrapper for the ValidateSpanFilterPattern operation
type ValidateSpanFilterPatternResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ValidateSpanFilterPatternResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ValidateSpanFilterPatternResponse) String() string