Class UploadLogFileRequest

Inheritance

object

UploadLogFileRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.LoganalyticsService.Requests

Assembly: OCI.DotNetSDK.Loganalytics.dll

Syntax

public class UploadLogFileRequest : IOciRequest

Examples

Click here to see an example of how to use UploadLogFile request.

Properties

CharEncoding

Declaration

[HttpConverter(TargetEnum.Query, "charEncoding")]
public string CharEncoding { get; set; }

Property Value

Type	Description
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.

ContentMd5

Declaration

[HttpConverter(TargetEnum.Header, "content-md5")]
public string ContentMd5 { get; set; }

Property Value

Type	Description
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)"

Type

Description

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

ContentType

Declaration

[HttpConverter(TargetEnum.Header, "content-type")]
public string ContentType { get; set; }

Property Value

Type	Description
string	The content type of the log data.

DateFormat

Declaration

[HttpConverter(TargetEnum.Query, "dateFormat")]
public string DateFormat { get; set; }

Property Value

Type	Description
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.

DateYear

Declaration

[HttpConverter(TargetEnum.Query, "dateYear")]
public string DateYear { get; set; }

Property Value

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

EntityId

Declaration

[HttpConverter(TargetEnum.Query, "entityId")]
public string EntityId { get; set; }

Property Value

Type	Description
string	The entity OCID.

Expect

Declaration

[HttpConverter(TargetEnum.Header, "expect")]
public string Expect { get; set; }

Property Value

Type	Description
string	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).

Filename

Declaration

[Required(ErrorMessage = "Filename is required.")]
[HttpConverter(TargetEnum.Query, "filename")]
public string Filename { get; set; }

Property Value

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

Remarks

Required

InvalidateCache

Declaration

[HttpConverter(TargetEnum.Query, "invalidateCache")]
public bool? InvalidateCache { get; set; }

Property Value

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

LogSet

Declaration

[HttpConverter(TargetEnum.Query, "logSet")]
public string LogSet { get; set; }

Property Value

Type	Description
string	The log set that gets associated with the uploaded logs.

LogSourceName

Declaration

[Required(ErrorMessage = "LogSourceName is required.")]
[HttpConverter(TargetEnum.Query, "logSourceName")]
public string LogSourceName { get; set; }

Property Value

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

Remarks

Required

NamespaceName

Declaration

[Required(ErrorMessage = "NamespaceName is required.")]
[HttpConverter(TargetEnum.Path, "namespaceName")]
public string NamespaceName { get; set; }

Property Value

Type	Description
string	The Logging Analytics namespace used for the request.

Remarks

Required

OpcMetaLoggrpid

Declaration

[Required(ErrorMessage = "OpcMetaLoggrpid is required.")]
[HttpConverter(TargetEnum.Header, "opc-meta-loggrpid")]
public string OpcMetaLoggrpid { get; set; }

Property Value

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

Remarks

Required

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	The client request ID for tracing.

OpcRetryToken

Declaration

[HttpConverter(TargetEnum.Header, "opc-retry-token")]
public string OpcRetryToken { get; set; }

Property Value

Type	Description
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.

Timezone

Declaration

[HttpConverter(TargetEnum.Query, "timezone")]
public string Timezone { get; set; }

Property Value

Type	Description
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

Declaration

[Required(ErrorMessage = "UploadLogFileBody is required.")]
[HttpConverter(TargetEnum.Body)]
public Stream UploadLogFileBody { get; set; }

Property Value

Type	Description
Stream	Log data

Remarks

Required

UploadName

Declaration

[HttpConverter(TargetEnum.Query, "uploadName")]
public string UploadName { get; set; }

Property Value

Type	Description
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.

Implements

IOciRequest