@Generated(value="software.amazon.awssdk:codegen") public final class CloudWatchLogsLogStream extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CloudWatchLogsLogStream.Builder,CloudWatchLogsLogStream>
Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.
Modifier and Type | Class and Description |
---|---|
static interface |
CloudWatchLogsLogStream.Builder |
Modifier and Type | Method and Description |
---|---|
Integer |
batchCount()
Specifies the max number of log events in a batch, up to 10000.
|
Integer |
batchSize()
Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes.
|
Integer |
bufferDuration()
Specifies the time duration for the batching of log events.
|
static CloudWatchLogsLogStream.Builder |
builder() |
String |
datetimeFormat()
Specifies how the time stamp is extracted from logs.
|
CloudWatchLogsEncoding |
encoding()
Specifies the encoding of the log file so that the file can be read correctly.
|
String |
encodingAsString()
Specifies the encoding of the log file so that the file can be read correctly.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
file()
Specifies log files that you want to push to CloudWatch Logs.
|
String |
fileFingerprintLines()
Specifies the range of lines for identifying a file.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
CloudWatchLogsInitialPosition |
initialPosition()
Specifies where to start to read data (start_of_file or end_of_file).
|
String |
initialPositionAsString()
Specifies where to start to read data (start_of_file or end_of_file).
|
String |
logGroupName()
Specifies the destination log group.
|
String |
multiLineStartPattern()
Specifies the pattern for identifying the start of a log message.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CloudWatchLogsLogStream.Builder> |
serializableBuilderClass() |
CloudWatchLogsTimeZone |
timeZone()
Specifies the time zone of log event time stamps.
|
String |
timeZoneAsString()
Specifies the time zone of log event time stamps.
|
CloudWatchLogsLogStream.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final String logGroupName()
Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).
public final String datetimeFormat()
Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.
public final CloudWatchLogsTimeZone timeZone()
Specifies the time zone of log event time stamps.
If the service returns an enum value that is not available in the current SDK version, timeZone
will
return CloudWatchLogsTimeZone.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from timeZoneAsString()
.
CloudWatchLogsTimeZone
public final String timeZoneAsString()
Specifies the time zone of log event time stamps.
If the service returns an enum value that is not available in the current SDK version, timeZone
will
return CloudWatchLogsTimeZone.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from timeZoneAsString()
.
CloudWatchLogsTimeZone
public final String file()
Specifies log files that you want to push to CloudWatch Logs.
File
can point to a specific file or multiple files (by using wild card characters such as
/var/log/system.log*
). Only the latest file is pushed to CloudWatch Logs, based on file modification
time. We recommend that you use wild card characters to specify a series of files of the same type, such as
access_log.2014-06-01-01
, access_log.2014-06-01-02
, and so on by using a pattern like
access_log.*
. Don't use a wildcard to match multiple file types, such as access_log_80
and access_log_443
. To specify multiple, different file types, add another log stream entry to the
configuration file, so that each log file type is stored in a different log group.
Zipped files are not supported.
File
can point to a specific file or multiple files (by using wild card characters such as
/var/log/system.log*
). Only the latest file is pushed to CloudWatch Logs, based on file
modification time. We recommend that you use wild card characters to specify a series of files of the
same type, such as access_log.2014-06-01-01
, access_log.2014-06-01-02
, and so
on by using a pattern like access_log.*
. Don't use a wildcard to match multiple file types,
such as access_log_80
and access_log_443
. To specify multiple, different file
types, add another log stream entry to the configuration file, so that each log file type is stored in a
different log group.
Zipped files are not supported.
public final String fileFingerprintLines()
Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.
public final String multiLineStartPattern()
Specifies the pattern for identifying the start of a log message.
public final CloudWatchLogsInitialPosition initialPosition()
Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.
If the service returns an enum value that is not available in the current SDK version, initialPosition
will return CloudWatchLogsInitialPosition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service
is available from initialPositionAsString()
.
CloudWatchLogsInitialPosition
public final String initialPositionAsString()
Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.
If the service returns an enum value that is not available in the current SDK version, initialPosition
will return CloudWatchLogsInitialPosition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service
is available from initialPositionAsString()
.
CloudWatchLogsInitialPosition
public final CloudWatchLogsEncoding encoding()
Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8
.
Encodings supported by Python codecs.decode()
can be used here.
If the service returns an enum value that is not available in the current SDK version, encoding
will
return CloudWatchLogsEncoding.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from encodingAsString()
.
utf_8
. Encodings supported by Python codecs.decode()
can be used here.CloudWatchLogsEncoding
public final String encodingAsString()
Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8
.
Encodings supported by Python codecs.decode()
can be used here.
If the service returns an enum value that is not available in the current SDK version, encoding
will
return CloudWatchLogsEncoding.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from encodingAsString()
.
utf_8
. Encodings supported by Python codecs.decode()
can be used here.CloudWatchLogsEncoding
public final Integer bufferDuration()
Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.
public final Integer batchCount()
Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
public final Integer batchSize()
Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
public CloudWatchLogsLogStream.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CloudWatchLogsLogStream.Builder,CloudWatchLogsLogStream>
public static CloudWatchLogsLogStream.Builder builder()
public static Class<? extends CloudWatchLogsLogStream.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.