@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CloudWatchLogsLogStream extends Object implements Serializable, Cloneable, StructuredPojo
Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.
Constructor and Description |
---|
CloudWatchLogsLogStream() |
Modifier and Type | Method and Description |
---|---|
CloudWatchLogsLogStream |
clone() |
boolean |
equals(Object obj) |
Integer |
getBatchCount()
Specifies the max number of log events in a batch, up to 10000.
|
Integer |
getBatchSize()
Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes.
|
Integer |
getBufferDuration()
Specifies the time duration for the batching of log events.
|
String |
getDatetimeFormat()
Specifies how the time stamp is extracted from logs.
|
String |
getEncoding()
Specifies the encoding of the log file so that the file can be read correctly.
|
String |
getFile()
Specifies log files that you want to push to CloudWatch Logs.
|
String |
getFileFingerprintLines()
Specifies the range of lines for identifying a file.
|
String |
getInitialPosition()
Specifies where to start to read data (start_of_file or end_of_file).
|
String |
getLogGroupName()
Specifies the destination log group.
|
String |
getMultiLineStartPattern()
Specifies the pattern for identifying the start of a log message.
|
String |
getTimeZone()
Specifies the time zone of log event time stamps.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBatchCount(Integer batchCount)
Specifies the max number of log events in a batch, up to 10000.
|
void |
setBatchSize(Integer batchSize)
Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes.
|
void |
setBufferDuration(Integer bufferDuration)
Specifies the time duration for the batching of log events.
|
void |
setDatetimeFormat(String datetimeFormat)
Specifies how the time stamp is extracted from logs.
|
void |
setEncoding(CloudWatchLogsEncoding encoding)
Specifies the encoding of the log file so that the file can be read correctly.
|
void |
setEncoding(String encoding)
Specifies the encoding of the log file so that the file can be read correctly.
|
void |
setFile(String file)
Specifies log files that you want to push to CloudWatch Logs.
|
void |
setFileFingerprintLines(String fileFingerprintLines)
Specifies the range of lines for identifying a file.
|
void |
setInitialPosition(CloudWatchLogsInitialPosition initialPosition)
Specifies where to start to read data (start_of_file or end_of_file).
|
void |
setInitialPosition(String initialPosition)
Specifies where to start to read data (start_of_file or end_of_file).
|
void |
setLogGroupName(String logGroupName)
Specifies the destination log group.
|
void |
setMultiLineStartPattern(String multiLineStartPattern)
Specifies the pattern for identifying the start of a log message.
|
void |
setTimeZone(CloudWatchLogsTimeZone timeZone)
Specifies the time zone of log event time stamps.
|
void |
setTimeZone(String timeZone)
Specifies the time zone of log event time stamps.
|
String |
toString()
Returns a string representation of this object.
|
CloudWatchLogsLogStream |
withBatchCount(Integer batchCount)
Specifies the max number of log events in a batch, up to 10000.
|
CloudWatchLogsLogStream |
withBatchSize(Integer batchSize)
Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes.
|
CloudWatchLogsLogStream |
withBufferDuration(Integer bufferDuration)
Specifies the time duration for the batching of log events.
|
CloudWatchLogsLogStream |
withDatetimeFormat(String datetimeFormat)
Specifies how the time stamp is extracted from logs.
|
CloudWatchLogsLogStream |
withEncoding(CloudWatchLogsEncoding encoding)
Specifies the encoding of the log file so that the file can be read correctly.
|
CloudWatchLogsLogStream |
withEncoding(String encoding)
Specifies the encoding of the log file so that the file can be read correctly.
|
CloudWatchLogsLogStream |
withFile(String file)
Specifies log files that you want to push to CloudWatch Logs.
|
CloudWatchLogsLogStream |
withFileFingerprintLines(String fileFingerprintLines)
Specifies the range of lines for identifying a file.
|
CloudWatchLogsLogStream |
withInitialPosition(CloudWatchLogsInitialPosition initialPosition)
Specifies where to start to read data (start_of_file or end_of_file).
|
CloudWatchLogsLogStream |
withInitialPosition(String initialPosition)
Specifies where to start to read data (start_of_file or end_of_file).
|
CloudWatchLogsLogStream |
withLogGroupName(String logGroupName)
Specifies the destination log group.
|
CloudWatchLogsLogStream |
withMultiLineStartPattern(String multiLineStartPattern)
Specifies the pattern for identifying the start of a log message.
|
CloudWatchLogsLogStream |
withTimeZone(CloudWatchLogsTimeZone timeZone)
Specifies the time zone of log event time stamps.
|
CloudWatchLogsLogStream |
withTimeZone(String timeZone)
Specifies the time zone of log event time stamps.
|
public void setLogGroupName(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).
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 String getLogGroupName()
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 CloudWatchLogsLogStream withLogGroupName(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).
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 void setDatetimeFormat(String datetimeFormat)
Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.
datetimeFormat
- Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent
Reference.public String getDatetimeFormat()
Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.
public CloudWatchLogsLogStream withDatetimeFormat(String datetimeFormat)
Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.
datetimeFormat
- Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent
Reference.public void setTimeZone(String timeZone)
Specifies the time zone of log event time stamps.
timeZone
- Specifies the time zone of log event time stamps.CloudWatchLogsTimeZone
public String getTimeZone()
Specifies the time zone of log event time stamps.
CloudWatchLogsTimeZone
public CloudWatchLogsLogStream withTimeZone(String timeZone)
Specifies the time zone of log event time stamps.
timeZone
- Specifies the time zone of log event time stamps.CloudWatchLogsTimeZone
public void setTimeZone(CloudWatchLogsTimeZone timeZone)
Specifies the time zone of log event time stamps.
timeZone
- Specifies the time zone of log event time stamps.CloudWatchLogsTimeZone
public CloudWatchLogsLogStream withTimeZone(CloudWatchLogsTimeZone timeZone)
Specifies the time zone of log event time stamps.
timeZone
- Specifies the time zone of log event time stamps.CloudWatchLogsTimeZone
public void setFile(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
- 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.
public String getFile()
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 CloudWatchLogsLogStream withFile(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
- 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.
public void setFileFingerprintLines(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.
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 String getFileFingerprintLines()
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 CloudWatchLogsLogStream withFileFingerprintLines(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.
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 void setMultiLineStartPattern(String multiLineStartPattern)
Specifies the pattern for identifying the start of a log message.
multiLineStartPattern
- Specifies the pattern for identifying the start of a log message.public String getMultiLineStartPattern()
Specifies the pattern for identifying the start of a log message.
public CloudWatchLogsLogStream withMultiLineStartPattern(String multiLineStartPattern)
Specifies the pattern for identifying the start of a log message.
multiLineStartPattern
- Specifies the pattern for identifying the start of a log message.public void setInitialPosition(String 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.
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.CloudWatchLogsInitialPosition
public String getInitialPosition()
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.
CloudWatchLogsInitialPosition
public CloudWatchLogsLogStream withInitialPosition(String 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.
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.CloudWatchLogsInitialPosition
public void setInitialPosition(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.
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.CloudWatchLogsInitialPosition
public CloudWatchLogsLogStream withInitialPosition(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.
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.CloudWatchLogsInitialPosition
public void setEncoding(String 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.
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.CloudWatchLogsEncoding
public String getEncoding()
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.
utf_8
. Encodings supported by Python codecs.decode()
can be used here.CloudWatchLogsEncoding
public CloudWatchLogsLogStream withEncoding(String 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.
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.CloudWatchLogsEncoding
public void setEncoding(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.
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.CloudWatchLogsEncoding
public CloudWatchLogsLogStream withEncoding(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.
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.CloudWatchLogsEncoding
public void setBufferDuration(Integer bufferDuration)
Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.
bufferDuration
- Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value
is 5000ms.public Integer getBufferDuration()
Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.
public CloudWatchLogsLogStream withBufferDuration(Integer bufferDuration)
Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.
bufferDuration
- Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value
is 5000ms.public void setBatchCount(Integer batchCount)
Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
batchCount
- Specifies the max number of log events in a batch, up to 10000. The default value is 1000.public Integer getBatchCount()
Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
public CloudWatchLogsLogStream withBatchCount(Integer batchCount)
Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
batchCount
- Specifies the max number of log events in a batch, up to 10000. The default value is 1000.public void setBatchSize(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.
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 Integer getBatchSize()
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 withBatchSize(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.
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 String toString()
toString
in class Object
Object.toString()
public CloudWatchLogsLogStream clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.