Package com.oracle.bmc.apmconfig.requests

Class PutDataFileRequest

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210201")
public class PutDataFileRequest
extends BmcRequest<InputStream>

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

    • Constructor Detail

      • PutDataFileRequest

        public PutDataFileRequest()

    • Method Detail

      • getPutDataFileBody

        public InputStream getPutDataFileBody()
        The data file to be uploaded.

      • getDataFileName

        public String getDataFileName()
        The name of the data file.

      • getApmDomainId

        public String getApmDomainId()
        The APM Domain ID the request is intended for.

      • getApmType

        public String getApmType()
        The type of the data file.

      • getContentMD5

        public String getContentMD5()
        Optional base64-encoded MD5 hash of the request body.

        If provided, the server will perform a data integrity check by computing the MD5 of the received content and comparing it to the supplied value.

        If the values do not match, the request will be rejected with an HTTP 400 error and a message such as:

        "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

      • getContentType

        public String getContentType()
        Optional parameter specifying the media type (MIME type) of the request or response body.

        If not specified, the default is application/octet-stream.

        This value can be used by recipients to determine how to interpret or render the content.

      • getContentLanguage

        public String getContentLanguage()
        Optional parameter that indicates the natural language of the content.

        This value can be used by clients or intermediaries to select or display content based on language preferences.

      • getContentEncoding

        public String getContentEncoding()
        Optional parameter indicating the content encodings applied to the request body (e.g., gzip, deflate).

        This value can be used by recipients to determine how to decode the content.

      • getContentDisposition

        public String getContentDisposition()
        Optional parameter that provides presentation information for how the content should be displayed or handled by the recipient.

        For example, to prompt a file download with a custom filename: attachment; filename="example.txt"

      • getMetadata

        public String getMetadata()
        A string containing a JSON-encoded object with metadata related to the uploaded file or resource.

        Example: {“fileName”:“report.pdf”,“uploader”:“jane.doe”,“category”:“financial”}

      • getOpcRetryToken

        public String getOpcRetryToken()
        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.

      • getOpcClientRequestId

        public String getOpcClientRequestId()
        The client request ID for tracing.

      • builder

        public static PutDataFileRequest.Builder builder()
        Return a new builder for this request object.
        Returns:
        builder for the request object

      • equals

        public boolean equals​(Object o)
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
        Overrides:
        equals in class BmcRequest<InputStream>

      • hashCode

        public int hashCode()
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to generate a hash.
        Overrides:
        hashCode in class BmcRequest<InputStream>