java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest
    - - software.amazon.awssdk.services.cloudwatchlogs.model.StartLiveTailRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartLiveTailRequest.Builder,StartLiveTailRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartLiveTailRequest
extends CloudWatchLogsRequest
implements ToCopyableBuilder<StartLiveTailRequest.Builder,StartLiveTailRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StartLiveTailRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StartLiveTailRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLogGroupIdentifiers()`	For responses, this returns true if the service returned a value for the LogGroupIdentifiers property.
`boolean`	`hasLogStreamNamePrefixes()`	For responses, this returns true if the service returned a value for the LogStreamNamePrefixes property.
`boolean`	`hasLogStreamNames()`	For responses, this returns true if the service returned a value for the LogStreamNames property.
`String`	`logEventFilterPattern()`	An optional pattern to use to filter the results to include only log events that match the pattern.
`List<String>`	`logGroupIdentifiers()`	An array where each item in the array is a log group to include in the Live Tail session.
`List<String>`	`logStreamNamePrefixes()`	If you specify this parameter, then only log events in the log streams that have names that start with the prefixes that you specify here are included in the Live Tail session.
`List<String>`	`logStreamNames()`	If you specify this parameter, then only log events in the log streams that you specify here are included in the Live Tail session.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartLiveTailRequest.Builder>`	`serializableBuilderClass()`
`StartLiveTailRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasLogGroupIdentifiers
```
public final boolean hasLogGroupIdentifiers()
```
    For responses, this returns true if the service returned a value for the LogGroupIdentifiers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - logGroupIdentifiers
```
public final List<String> logGroupIdentifiers()
```
    An array where each item in the array is a log group to include in the Live Tail session.
    
    Specify each log group by its ARN.
    
    If you specify an ARN, the ARN can't end with an asterisk (*).
    
    You can include up to 10 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 hasLogGroupIdentifiers() method.
    
    Returns:
    
    An array where each item in the array is a log group to include in the Live Tail session.
    
    Specify each log group by its ARN.
    
    If you specify an ARN, the ARN can't end with an asterisk (*).
    
    You can include up to 10 log groups.
  - hasLogStreamNames
```
public final boolean hasLogStreamNames()
```
    For responses, this returns true if the service returned a value for the LogStreamNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - logStreamNames
```
public final List<String> logStreamNames()
```
    If you specify this parameter, then only log events in the log streams that you specify here are included in the Live Tail session.
    
    If you specify this field, you can't also specify the logStreamNamePrefixes field.
    
    You can specify this parameter only if you specify only one log group in logGroupIdentifiers.
    
    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 hasLogStreamNames() method.
    
    Returns:
    
    If you specify this parameter, then only log events in the log streams that you specify here are included in the Live Tail session.
    
    If you specify this field, you can't also specify the logStreamNamePrefixes field.
    
    You can specify this parameter only if you specify only one log group in logGroupIdentifiers .
  - hasLogStreamNamePrefixes
```
public final boolean hasLogStreamNamePrefixes()
```
    For responses, this returns true if the service returned a value for the LogStreamNamePrefixes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - logStreamNamePrefixes
```
public final List<String> logStreamNamePrefixes()
```
    If you specify this parameter, then only log events in the log streams that have names that start with the prefixes that you specify here are included in the Live Tail session.
    
    If you specify this field, you can't also specify the logStreamNames field.
    
    You can specify this parameter only if you specify only one log group in logGroupIdentifiers.
    
    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 hasLogStreamNamePrefixes() method.
    
    Returns:
    
    If you specify this parameter, then only log events in the log streams that have names that start with the prefixes that you specify here are included in the Live Tail session.
    
    If you specify this field, you can't also specify the logStreamNames field.
    
    You can specify this parameter only if you specify only one log group in logGroupIdentifiers .
  - logEventFilterPattern
```
public final String logEventFilterPattern()
```
    An optional pattern to use to filter the results to include only log events that match the pattern. For example, a filter pattern of error 404 causes only log events that include both error and 404 to be included in the Live Tail stream.
    
    Regular expression filter patterns are supported.
    
    For more information about filter pattern syntax, see Filter and Pattern Syntax.
    
    Returns:
    
    An optional pattern to use to filter the results to include only log events that match the pattern. For example, a filter pattern of error 404 causes only log events that include both error and 404 to be included in the Live Tail stream.
    
    Regular expression filter patterns are supported.
    
    For more information about filter pattern syntax, see Filter and Pattern Syntax.
  - toBuilder
```
public StartLiveTailRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartLiveTailRequest.Builder,StartLiveTailRequest>
    
    Specified by:
    
    toBuilder in class CloudWatchLogsRequest
  - builder
```
public static StartLiveTailRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartLiveTailRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class StartLiveTailRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasLogGroupIdentifiers

logGroupIdentifiers

hasLogStreamNames

logStreamNames

hasLogStreamNamePrefixes

logStreamNamePrefixes

logEventFilterPattern

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField