Class StartLiveTailRequest

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>

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartLiveTailRequest.Builder,StartLiveTailRequest>
      Specified by:
      toBuilder in class CloudWatchLogsRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.