Class ListLogGroupsRequest

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

  • Method Details

    • logGroupNamePattern

      public final String logGroupNamePattern()

      Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.

      • Use ^ to match log group names by prefix.

      • For a substring match, specify the string to match. All matches are case sensitive

      • To match multiple patterns, separate them with a | as in the example ^/aws/lambda|discovery

      You can specify as many as five different regular expression patterns in this field, each of which must be between 3 and 24 characters. You can include the ^ symbol as many as five times, and include the | symbol as many as four times.

      Returns:
      Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.

      • Use ^ to match log group names by prefix.

      • For a substring match, specify the string to match. All matches are case sensitive

      • To match multiple patterns, separate them with a | as in the example ^/aws/lambda|discovery

      You can specify as many as five different regular expression patterns in this field, each of which must be between 3 and 24 characters. You can include the ^ symbol as many as five times, and include the | symbol as many as four times.

    • logGroupClass

      public final LogGroupClass logGroupClass()

      Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.

      If the service returns an enum value that is not available in the current SDK version, logGroupClass will return LogGroupClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logGroupClassAsString().

      Returns:
      Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.
      See Also:

    • logGroupClassAsString

      public final String logGroupClassAsString()

      Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.

      If the service returns an enum value that is not available in the current SDK version, logGroupClass will return LogGroupClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logGroupClassAsString().

      Returns:
      Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.
      See Also:

    • includeLinkedAccounts

      public final Boolean includeLinkedAccounts()

      If you are using a monitoring account, set this to true to have the operation return log groups in the accounts listed in accountIdentifiers.

      If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

      The default for this parameter is false.

      Returns:
      If you are using a monitoring account, set this to true to have the operation return log groups in the accounts listed in accountIdentifiers.

      If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

      The default for this parameter is false.

    • hasAccountIdentifiers

      public final boolean hasAccountIdentifiers()
      For responses, this returns true if the service returned a value for the AccountIdentifiers 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.

    • accountIdentifiers

      public final List<String> accountIdentifiers()

      When includeLinkedAccounts is set to true, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

      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 hasAccountIdentifiers() method.

      Returns:
      When includeLinkedAccounts is set to true, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

    • nextToken

      public final String nextToken()
      Returns the value of the NextToken property for this object.
      Returns:
      The value of the NextToken property for this object.

    • limit

      public final Integer limit()

      The maximum number of log groups to return. If you omit this parameter, the default is up to 50 log groups.

      Returns:
      The maximum number of log groups to return. If you omit this parameter, the default is up to 50 log groups.

    • hasDataSources

      public final boolean hasDataSources()
      For responses, this returns true if the service returned a value for the DataSources 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.

    • dataSources

      public final List<DataSourceFilter> dataSources()

      An array of data source filters to filter log groups by their associated data sources. You can filter by data source name, type, or both. Multiple filters within the same dimension are combined with OR logic, while filters across different dimensions are combined with AND logic.

      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 hasDataSources() method.

      Returns:
      An array of data source filters to filter log groups by their associated data sources. You can filter by data source name, type, or both. Multiple filters within the same dimension are combined with OR logic, while filters across different dimensions are combined with AND logic.

    • hasFieldIndexNames

      public final boolean hasFieldIndexNames()
      For responses, this returns true if the service returned a value for the FieldIndexNames 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.

    • fieldIndexNames

      public final List<String> fieldIndexNames()

      An array of field index names to filter log groups that have specific field indexes. Only log groups containing all specified field indexes are returned. You can specify 1 to 20 field index names, each with 1 to 512 characters.

      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 hasFieldIndexNames() method.

      Returns:
      An array of field index names to filter log groups that have specific field indexes. Only log groups containing all specified field indexes are returned. You can specify 1 to 20 field index names, each with 1 to 512 characters.

    • toBuilder

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

    • builder

      public static ListLogGroupsRequest.Builder builder()

    • serializableBuilderClass

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