com.oracle.bmc.loganalytics.requests

Class UploadLogFileRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<InputStream>

com.oracle.bmc.loganalytics.requests.UploadLogFileRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public class UploadLogFileRequest
extends com.oracle.bmc.requests.BmcRequest<InputStream>

Example: Click here to see how to use UploadLogFileRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UploadLogFileRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UploadLogFileRequest.Builder	builder()
InputStream	getBody$() Alternative accessor for the body parameter.
String	getCharEncoding() Character encoding to be used to detect the encoding type of file(s) being uploaded.
String	getContentMd5() The base-64 encoded MD5 hash of the body.
String	getContentType() The content type of the log data.
String	getDateFormat() This property is used to specify the format of the date.
String	getDateYear() Used to indicate the year where the log entries timestamp do not mention year (Ex: Nov 8 20:45:56).
String	getEntityId() The entity OCID.
String	getFilename() The name of the file being uploaded.
Boolean	getInvalidateCache() This property can be used to reset configuration cache in case of an issue with the upload.
String	getLogSourceName() Name of the log source that will be used to process the files being uploaded.
String	getNamespaceName() The Logging Analytics namespace used for the request.
String	getOpcMetaLoggrpid() The log group OCID to which the log data in this upload will be mapped to.
String	getOpcRequestId() The client request ID for tracing.
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.
String	getTimezone() Timezone to be used when processing log entries whose timestamps do not include an explicit timezone.
InputStream	getUploadLogFileBody() Log data
String	getUploadName() The name of the upload.

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBody$

public InputStream getBody$()

Alternative accessor for the body parameter.

Overrides:

getBody$ in class com.oracle.bmc.requests.BmcRequest<InputStream>

Returns:

body parameter

builder

public static UploadLogFileRequest.Builder builder()

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.