Class CloudWatchLogsSource
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CloudWatchLogsSource.Builder,CloudWatchLogsSource>
The configuration for reading agent traces from CloudWatch Logs.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic CloudWatchLogsSource.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final CloudWatchFilterConfigOptional filter configuration to narrow down which sessions to evaluate.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final booleanFor responses, this returns true if the service returned a value for the LogGroupNames property.final booleanFor responses, this returns true if the service returned a value for the ServiceNames property.The list of CloudWatch log group names to read agent traces from.static Class<? extends CloudWatchLogsSource.Builder> The list of agent service names to filter traces within the specified log groups.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasServiceNames
public final boolean hasServiceNames()For responses, this returns true if the service returned a value for the ServiceNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
serviceNames
The list of agent service names to filter traces within the specified log groups.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasServiceNames()method.- Returns:
- The list of agent service names to filter traces within the specified log groups.
-
hasLogGroupNames
public final boolean hasLogGroupNames()For responses, this returns true if the service returned a value for the LogGroupNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
logGroupNames
The list of CloudWatch log group names to read agent traces from. Maximum of 5 log groups.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLogGroupNames()method.- Returns:
- The list of CloudWatch log group names to read agent traces from. Maximum of 5 log groups.
-
filterConfig
Optional filter configuration to narrow down which sessions to evaluate.
- Returns:
- Optional filter configuration to narrow down which sessions to evaluate.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CloudWatchLogsSource.Builder,CloudWatchLogsSource> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-