Package software.amazon.awssdk.services.cloudwatchlogs.model

Class StartQueryRequest

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.StartQueryRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartQueryRequest.Builder,StartQueryRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartQueryRequest extends CloudWatchLogsRequest implements ToCopyableBuilder<StartQueryRequest.Builder,StartQueryRequest>

  • Method Details

    • logGroupName

      public final String logGroupName()

      The log group on which to perform the query.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

      Returns:
      The log group on which to perform the query.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

    • 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 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.

    • logGroupNames

      public final List<String> logGroupNames()

      The list of log groups to be queried. You can include up to 50 log groups.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or 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 hasLogGroupNames() method.

      Returns:
      The list of log groups to be queried. You can include up to 50 log groups.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

    • 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()

      The list of log groups to query. You can include up to 50 log groups.

      You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

      If you specify an ARN, the ARN can't end with an asterisk (*).

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or 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 hasLogGroupIdentifiers() method.

      Returns:
      The list of log groups to query. You can include up to 50 log groups.

      You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

      If you specify an ARN, the ARN can't end with an asterisk (*).

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

    • startTime

      public final Long startTime()

      The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

      Returns:
      The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

    • endTime

      public final Long endTime()

      The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

      Returns:
      The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

    • queryString

      public final String queryString()

      The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

      Returns:
      The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

    • limit

      public final Integer limit()

      The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

      Returns:
      The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

    • toBuilder

      public StartQueryRequest.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<StartQueryRequest.Builder,StartQueryRequest>
      Specified by:
      toBuilder in class CloudWatchLogsRequest
      Returns:
      a builder for type T

    • builder

      public static StartQueryRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartQueryRequest.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.