Class CloudWatchLogsSourceConfig
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CloudWatchLogsSourceConfig.Builder,CloudWatchLogsSourceConfig>
A CloudWatch Logs source for a dataset generation. Specify either logGroupNames or
logGroupNamePrefixes.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final InstantendTime()The end of the time window to read sessions from.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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 LogGroupNamePrefixes property.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.Prefixes of the names of the log groups to read, from 1 to 5.The names of the log groups to read, from 1 to 5.static Class<? extends CloudWatchLogsSourceConfig.Builder> The service name of the agent, which matches theservice.nameresource attribute in its traces.final InstantThe start of the time window to read sessions from.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
-
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 names of the log groups to read, from 1 to 5. You can't specify this together with
logGroupNamePrefixes.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 names of the log groups to read, from 1 to 5. You can't specify this together with
logGroupNamePrefixes.
-
hasLogGroupNamePrefixes
public final boolean hasLogGroupNamePrefixes()For responses, this returns true if the service returned a value for the LogGroupNamePrefixes 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. -
logGroupNamePrefixes
Prefixes of the names of the log groups to read, from 1 to 5. You can't specify this together with
logGroupNames.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
hasLogGroupNamePrefixes()method.- Returns:
- Prefixes of the names of the log groups to read, from 1 to 5. You can't specify this together with
logGroupNames.
-
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 service name of the agent, which matches the
service.nameresource attribute in its traces. Specify exactly one.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 service name of the agent, which matches the
service.nameresource attribute in its traces. Specify exactly one.
-
startTime
The start of the time window to read sessions from. The default is 7 days before
endTime.- Returns:
- The start of the time window to read sessions from. The default is 7 days before
endTime.
-
endTime
The end of the time window to read sessions from. The default is the time the generation starts.
- Returns:
- The end of the time window to read sessions from. The default is the time the generation starts.
-
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<CloudWatchLogsSourceConfig.Builder,CloudWatchLogsSourceConfig> - 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.
-