Package com.oracle.bmc.apmtraces

Interface AttributesAsync

    • 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 serice.

      • 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

        Future<BulkActivateAttributeResponse> bulkActivateAttribute​(BulkActivateAttributeRequest request,
                                                            AsyncHandler<BulkActivateAttributeRequest,​BulkActivateAttributeResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • bulkDeActivateAttribute

        Future<BulkDeActivateAttributeResponse> bulkDeActivateAttribute​(BulkDeActivateAttributeRequest request,
                                                                AsyncHandler<BulkDeActivateAttributeRequest,​BulkDeActivateAttributeResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • bulkPinAttribute

        Future<BulkPinAttributeResponse> bulkPinAttribute​(BulkPinAttributeRequest request,
                                                  AsyncHandler<BulkPinAttributeRequest,​BulkPinAttributeResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • bulkUnpinAttribute

        Future<BulkUnpinAttributeResponse> bulkUnpinAttribute​(BulkUnpinAttributeRequest request,
                                                      AsyncHandler<BulkUnpinAttributeRequest,​BulkUnpinAttributeResponse> handler)
        Unpin a set of attributes in the APM Domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • bulkUpdateAttribute

        Future<BulkUpdateAttributeResponse> bulkUpdateAttribute​(BulkUpdateAttributeRequest request,
                                                        AsyncHandler<BulkUpdateAttributeRequest,​BulkUpdateAttributeResponse> handler)
        Update a set of attribute properties in the APM Domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • bulkUpdateAttributeNotes

        Future<BulkUpdateAttributeNotesResponse> bulkUpdateAttributeNotes​(BulkUpdateAttributeNotesRequest request,
                                                                  AsyncHandler<BulkUpdateAttributeNotesRequest,​BulkUpdateAttributeNotesResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getStatusAutoActivate

        Future<GetStatusAutoActivateResponse> getStatusAutoActivate​(GetStatusAutoActivateRequest request,
                                                            AsyncHandler<GetStatusAutoActivateRequest,​GetStatusAutoActivateResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • putToggleAutoActivate

        Future<PutToggleAutoActivateResponse> putToggleAutoActivate​(PutToggleAutoActivateRequest request,
                                                            AsyncHandler<PutToggleAutoActivateRequest,​PutToggleAutoActivateResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.