Class UploadLogFileRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.loganalytics.requests.UploadLogFileRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<UploadLogFileRequest,InputStream>
- Enclosing class:
- UploadLogFileRequest
public static class UploadLogFileRequest.Builder extends Object implements BmcRequest.Builder<UploadLogFileRequest,InputStream>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UploadLogFileRequest.Builderbody$(InputStream body)Alternative setter for the body parameter.UploadLogFileRequestbuild()Build the instance of UploadLogFileRequest as configured by this builderUploadLogFileRequestbuildWithoutInvocationCallback()Build the instance of UploadLogFileRequest as configured by this builderUploadLogFileRequest.BuildercharEncoding(String charEncoding)Character encoding to be used to detect the encoding type of file(s) being uploaded.UploadLogFileRequest.BuildercontentMd5(String contentMd5)The base-64 encoded MD5 hash of the body.UploadLogFileRequest.BuildercontentType(String contentType)The content type of the log data.UploadLogFileRequest.Buildercopy(UploadLogFileRequest o)Copy method to populate the builder with values from the given instance.UploadLogFileRequest.BuilderdateFormat(String dateFormat)This property is used to specify the format of the date.UploadLogFileRequest.BuilderdateYear(String dateYear)Used to indicate the year where the log entries timestamp do not mention year (Ex: Nov 8 20:45:56).UploadLogFileRequest.BuilderentityId(String entityId)The entity OCID.UploadLogFileRequest.Builderexpect(String expect)A value of 100-continue requests preliminary verification of the request method, path, and headers before the request body is sent.UploadLogFileRequest.Builderfilename(String filename)The name of the file being uploaded.UploadLogFileRequest.BuilderinvalidateCache(Boolean invalidateCache)This property can be used to reset configuration cache in case of an issue with the upload.UploadLogFileRequest.BuilderinvocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)Set the invocation callback for the request to be built.UploadLogFileRequest.BuilderlogSet(String logSet)The log set that gets associated with the uploaded logs.UploadLogFileRequest.BuilderlogSourceName(String logSourceName)Name of the log source that will be used to process the files being uploaded.UploadLogFileRequest.BuildernamespaceName(String namespaceName)The Logging Analytics namespace used for the request.UploadLogFileRequest.BuilderopcMetaLoggrpid(String opcMetaLoggrpid)The log group OCID to which the log data in this upload will be mapped to.UploadLogFileRequest.BuilderopcRequestId(String opcRequestId)The client request ID for tracing.UploadLogFileRequest.BuilderopcRetryToken(String opcRetryToken)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.UploadLogFileRequest.BuilderretryConfiguration(RetryConfiguration retryConfiguration)Set the retry configuration for the request to be built.UploadLogFileRequest.Buildertimezone(String timezone)Timezone to be used when processing log entries whose timestamps do not include an explicit timezone.UploadLogFileRequest.BuilderuploadLogFileBody(InputStream uploadLogFileBody)Log dataUploadLogFileRequest.BuilderuploadName(String uploadName)The name of the upload.
-
-
-
Method Detail
-
namespaceName
public UploadLogFileRequest.Builder namespaceName(String namespaceName)
The Logging Analytics namespace used for the request.- Parameters:
namespaceName- the value to set- Returns:
- this builder instance
-
logSourceName
public UploadLogFileRequest.Builder logSourceName(String logSourceName)
Name of the log source that will be used to process the files being uploaded.- Parameters:
logSourceName- the value to set- Returns:
- this builder instance
-
filename
public UploadLogFileRequest.Builder filename(String filename)
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).
- Parameters:
filename- the value to set- Returns:
- this builder instance
-
opcMetaLoggrpid
public UploadLogFileRequest.Builder opcMetaLoggrpid(String opcMetaLoggrpid)
The log group OCID to which the log data in this upload will be mapped to.- Parameters:
opcMetaLoggrpid- the value to set- Returns:
- this builder instance
-
uploadLogFileBody
public UploadLogFileRequest.Builder uploadLogFileBody(InputStream uploadLogFileBody)
Log data- Parameters:
uploadLogFileBody- the value to set- Returns:
- this builder instance
-
uploadName
public UploadLogFileRequest.Builder uploadName(String uploadName)
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.
- Parameters:
uploadName- the value to set- Returns:
- this builder instance
-
entityId
public UploadLogFileRequest.Builder entityId(String entityId)
The entity OCID.- Parameters:
entityId- the value to set- Returns:
- this builder instance
-
timezone
public UploadLogFileRequest.Builder timezone(String timezone)
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
- Parameters:
timezone- the value to set- Returns:
- this builder instance
-
charEncoding
public UploadLogFileRequest.Builder charEncoding(String charEncoding)
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.
- Parameters:
charEncoding- the value to set- Returns:
- this builder instance
-
dateFormat
public UploadLogFileRequest.Builder dateFormat(String dateFormat)
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.
- Parameters:
dateFormat- the value to set- Returns:
- this builder instance
-
dateYear
public UploadLogFileRequest.Builder dateYear(String dateYear)
Used to indicate the year where the log entries timestamp do not mention year (Ex: Nov 8 20:45:56).- Parameters:
dateYear- the value to set- Returns:
- this builder instance
-
invalidateCache
public UploadLogFileRequest.Builder invalidateCache(Boolean invalidateCache)
This property can be used to reset configuration cache in case of an issue with the upload.- Parameters:
invalidateCache- the value to set- Returns:
- this builder instance
-
opcRequestId
public UploadLogFileRequest.Builder opcRequestId(String opcRequestId)
The client request ID for tracing.- Parameters:
opcRequestId- the value to set- Returns:
- this builder instance
-
contentMd5
public UploadLogFileRequest.Builder contentMd5(String contentMd5)
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)"
- Parameters:
contentMd5- the value to set- Returns:
- this builder instance
-
contentType
public UploadLogFileRequest.Builder contentType(String contentType)
The content type of the log data.- Parameters:
contentType- the value to set- Returns:
- this builder instance
-
opcRetryToken
public UploadLogFileRequest.Builder opcRetryToken(String opcRetryToken)
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.
- Parameters:
opcRetryToken- the value to set- Returns:
- this builder instance
-
logSet
public UploadLogFileRequest.Builder logSet(String logSet)
The log set that gets associated with the uploaded logs.- Parameters:
logSet- the value to set- Returns:
- this builder instance
-
expect
public UploadLogFileRequest.Builder expect(String expect)
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).
- Parameters:
expect- the value to set- Returns:
- this builder instance
-
invocationCallback
public UploadLogFileRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.- Parameters:
invocationCallback- the invocation callback to be set for the request- Returns:
- this builder instance
-
retryConfiguration
public UploadLogFileRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.- Parameters:
retryConfiguration- the retry configuration to be used for the request- Returns:
- this builder instance
-
copy
public UploadLogFileRequest.Builder copy(UploadLogFileRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copyin interfaceBmcRequest.Builder<UploadLogFileRequest,InputStream>- Parameters:
o- other request from which to copy values- Returns:
- this builder instance
-
build
public UploadLogFileRequest build()
Build the instance of UploadLogFileRequest as configured by this builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)into account, while the methodbuildWithoutInvocationCallback()does not.This is the preferred method to build an instance.
- Specified by:
buildin interfaceBmcRequest.Builder<UploadLogFileRequest,InputStream>- Returns:
- instance of UploadLogFileRequest
-
body$
public UploadLogFileRequest.Builder body$(InputStream body)
Alternative setter for the body parameter.- Specified by:
body$in interfaceBmcRequest.Builder<UploadLogFileRequest,InputStream>- Parameters:
body- the body parameter- Returns:
- this builder instance
-
buildWithoutInvocationCallback
public UploadLogFileRequest buildWithoutInvocationCallback()
Build the instance of UploadLogFileRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)into account, while the methodbuild()does- Returns:
- instance of UploadLogFileRequest
-
-