Class DescribeLogGroupsRequest

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

  • Method Details

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

    • logGroupNamePrefix

      public final String logGroupNamePrefix()

      The prefix to match.

      logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

      Returns:
      The prefix to match.

      logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

    • logGroupNamePattern

      public final String logGroupNamePattern()

      If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

      If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

      logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

      Returns:
      If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo , log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

      If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

      logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

    • nextToken

      public final String nextToken()

      The token for the next set of items to return. (You received this token from a previous call.)

      Returns:
      The token for the next set of items to return. (You received this token from a previous call.)

    • limit

      public final Integer limit()

      The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

      Returns:
      The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

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

      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.

    • logGroupClass

      public final LogGroupClass logGroupClass()

      Specifies the log group class for this log group. There are two classes:

      • The Standard log class supports all CloudWatch Logs features.

      • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

      For details about the features supported by each class, see Log classes

      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:
      Specifies the log group class for this log group. There are two classes:

      • The Standard log class supports all CloudWatch Logs features.

      • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

      For details about the features supported by each class, see Log classes

      See Also:

    • logGroupClassAsString

      public final String logGroupClassAsString()

      Specifies the log group class for this log group. There are two classes:

      • The Standard log class supports all CloudWatch Logs features.

      • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

      For details about the features supported by each class, see Log classes

      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:
      Specifies the log group class for this log group. There are two classes:

      • The Standard log class supports all CloudWatch Logs features.

      • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

      For details about the features supported by each class, see Log classes

      See Also:

    • toBuilder

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

    • builder

      public static DescribeLogGroupsRequest.Builder builder()

    • serializableBuilderClass

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