Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UploadLogFileRequest

example

Click here to see how to use UploadLogFileRequest.

Hierarchy

Properties

Optional charEncoding

charEncoding: undefined | string

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.

Optional contentMd5

contentMd5: undefined | string

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)\"

Optional contentType

contentType: undefined | string

The content type of the log data.

Optional dateFormat

dateFormat: undefined | string

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.

Optional dateYear

dateYear: undefined | string

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

Optional entityId

entityId: undefined | string

The entity OCID.

Optional expect

expect: undefined | string

A value of {@code 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).

filename

filename: string

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

Optional invalidateCache

invalidateCache: undefined | false | true

This property can be used to reset configuration cache in case of an issue with the upload.

Optional logSet

logSet: undefined | string

The log set that gets associated with the uploaded logs.

logSourceName

logSourceName: string

Name of the log source that will be used to process the files being uploaded.

namespaceName

namespaceName: string

The Logging Analytics namespace used for the request.

opcMetaLoggrpid

opcMetaLoggrpid: string

The log group OCID to which the log data in this upload will be mapped to.

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional opcRetryToken

opcRetryToken: undefined | string

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.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional timezone

timezone: undefined | string

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

uploadLogFileBody

uploadLogFileBody: Uint8Array | Buffer | Blob | stream.Readable | ReadableStream | string

Log data

uploadName

uploadName: string

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.