Package com.oracle.bmc.loganalytics.requests

Class UploadLogFileRequest

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

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

    • Constructor Detail

      • UploadLogFileRequest

        public UploadLogFileRequest()

    • Method Detail

      • getNamespaceName

        public String getNamespaceName()
        The Logging Analytics namespace used for the request.

      • getUploadName

        public String getUploadName()
        The name of the upload.

        This can be considered as a container name where different kind of logs will be collected and searched together. This upload name/id can further be used for retrieving the details of the upload, including its status or deleting the upload.

      • getLogSourceName

        public String getLogSourceName()
        Name of the log source that will be used to process the files being uploaded.

      • getFilename

        public String getFilename()
        The name of the file being uploaded.

        The extension of the filename part will be used to detect the type of file (like zip, tar).

      • getOpcMetaLoggrpid

        public String getOpcMetaLoggrpid()
        The log group OCID to which the log data in this upload will be mapped to.

      • getUploadLogFileBody

        public InputStream getUploadLogFileBody()
        Log data

      • getEntityId

        public String getEntityId()
        The entity OCID.

      • getTimezone

        public String getTimezone()
        Timezone to be used when processing log entries whose timestamps do not include an explicit timezone.

        When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used

      • getCharEncoding

        public String getCharEncoding()
        Character encoding to be used to detect the encoding type of file(s) being uploaded.

        When this property is not specified, system detected character encoding will be used.

      • getDateFormat

        public String getDateFormat()
        This property is used to specify the format of the date.

        This is to be used for ambiguous dates like 12/11/10. This property can take any of the following values - MONTH_DAY_YEAR, DAY_MONTH_YEAR, YEAR_MONTH_DAY, MONTH_DAY, DAY_MONTH.

      • getDateYear

        public String getDateYear()
        Used to indicate the year where the log entries timestamp do not mention year (Ex: Nov 8 20:45:56).

      • getInvalidateCache

        public Boolean getInvalidateCache()
        This property can be used to reset configuration cache in case of an issue with the upload.

      • getOpcRequestId

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

      • getContentMd5

        public String getContentMd5()
        The base-64 encoded MD5 hash of the body.

        If the Content-MD5 header is present, Logging Analytics performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the log data is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message:

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

      • getContentType

        public String getContentType()
        The content type of the log data.

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

      • getLogSet

        public String getLogSet()
        The log set that gets associated with the uploaded logs.

      • getExpect

        public String getExpect()
        A value of 100-continue requests preliminary verification of the request method, path, and headers before the request body is sent.

        If no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body. The only allowed value for this parameter is “100-Continue” (case-insensitive).

      • supportsExpect100Continue

        public boolean supportsExpect100Continue()
        Description copied from class: BmcRequest
        Returns true if this operation supports Expect: 100-Continue.
        Overrides:
        supportsExpect100Continue in class BmcRequest<InputStream>
        Returns:
        true if this operation supports Expect: 100-Continue.

      • builder

        public static UploadLogFileRequest.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>