Package com.oracle.bmc.apmtraces

Interface Attributes

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    AttributesClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public interface Attributes
extends AutoCloseable
    Use the Application Performance Monitoring Trace Explorer API to query traces and associated spans in Trace Explorer.

    For more information, see Application Performance Monitoring.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • bulkActivateAttribute

        BulkActivateAttributeResponse bulkActivateAttribute​(BulkActivateAttributeRequest request)
        Activates a set of attributes for the given APM Domain.

        The API is not case-sensitive. Any duplicates present in the bulk activation request are deduplicated and only unique attributes are activated. A maximum number of 700 string attributes and 100 numeric attributes can be activated in an APM Domain subject to the available string and numeric slots. Once an attribute has been activated, it may take sometime for it to be appear in searches as ingest might not have picked up the changes or any associated caches might not have refreshed. The bulk activation operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they get a success status back. If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk request are activated. Attributes that are activated are unpinned by default if they are pinned.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apmtraces/BulkActivateAttributeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BulkActivateAttribute API.

      • bulkDeActivateAttribute

        BulkDeActivateAttributeResponse bulkDeActivateAttribute​(BulkDeActivateAttributeRequest request)
        Deactivates a set of attributes for the given APM Domain.

        The API is case in-sensitive. Any duplicates present in the bulk deactivation request are deduplicated and only unique attributes are deactivated. A maximum number of 700 string attributes and 100 numeric attributes can be deactivated in an APM Domain subject to the available string and numeric slots. Out of box attributes (Trace and Span) cannot be deactivated, and will result in a processing error. Once an attribute has been deactivated, it may take sometime for it to disappear in searches as ingest might not have picked up the changes or any associated caches might not have refreshed. The bulk deactivation operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they get a success status back. If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk request are deactivated.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apmtraces/BulkDeActivateAttributeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BulkDeActivateAttribute API.

      • bulkPinAttribute

        BulkPinAttributeResponse bulkPinAttribute​(BulkPinAttributeRequest request)
        Pin a set of attributes in the APM Domain.

        Attributes that are marked pinned are not autoactivated by ingest. Attributes that are deactivated are pinned by default.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apmtraces/BulkPinAttributeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BulkPinAttribute API.

      • bulkUnpinAttribute

        BulkUnpinAttributeResponse bulkUnpinAttribute​(BulkUnpinAttributeRequest request)
        Unpin a set of attributes in the APM Domain.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apmtraces/BulkUnpinAttributeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BulkUnpinAttribute API.

      • bulkUpdateAttribute

        BulkUpdateAttributeResponse bulkUpdateAttribute​(BulkUpdateAttributeRequest request)
        Update a set of attribute properties in the APM Domain.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apmtraces/BulkUpdateAttributeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BulkUpdateAttribute API.

      • bulkUpdateAttributeNotes

        BulkUpdateAttributeNotesResponse bulkUpdateAttributeNotes​(BulkUpdateAttributeNotesRequest request)
        Add or edit notes to a set of attributes in the APM Domain.

        Notes can be added to either an active or an inactive attribute. The notes will be preserved even if the attribute changes state (when an active attribute is deactivated or when an inactive attribute is activated).

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apmtraces/BulkUpdateAttributeNotesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BulkUpdateAttributeNotes API.

      • getStatusAutoActivate

        GetStatusAutoActivateResponse getStatusAutoActivate​(GetStatusAutoActivateRequest request)
        Get autoactivation status for a private data key or public data key in the APM Domain.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apmtraces/GetStatusAutoActivateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetStatusAutoActivate API.

      • putToggleAutoActivate

        PutToggleAutoActivateResponse putToggleAutoActivate​(PutToggleAutoActivateRequest request)
        Turn on or off autoactivate for private data key or public data key traffic a given APM Domain.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apmtraces/PutToggleAutoActivateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PutToggleAutoActivate API.