@Generated(value="software.amazon.awssdk:codegen") public final class DescribeLogGroupsRequest extends CloudWatchLogsRequest implements ToCopyableBuilder<DescribeLogGroupsRequest.Builder,DescribeLogGroupsRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeLogGroupsRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<String> |
accountIdentifiers()
When
includeLinkedAccounts is set to True, use this parameter to specify the list of
accounts to search. |
static DescribeLogGroupsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAccountIdentifiers()
For responses, this returns true if the service returned a value for the AccountIdentifiers property.
|
int |
hashCode() |
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. |
Integer |
limit()
The maximum number of items returned.
|
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.
|
String |
logGroupNamePrefix()
The prefix to match.
|
String |
nextToken()
The token for the next set of items to return.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeLogGroupsRequest.Builder> |
serializableBuilderClass() |
DescribeLogGroupsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasAccountIdentifiers()
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.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.
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.public final String logGroupNamePrefix()
The prefix to match.
logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these
parameters can be passed.
logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of
these parameters can be passed.
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.
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.
public final String nextToken()
The token for the next set of items to return. (You received this token from a previous call.)
public final Integer limit()
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
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.
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.
public DescribeLogGroupsRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeLogGroupsRequest.Builder,DescribeLogGroupsRequest>toBuilder in class CloudWatchLogsRequestpublic static DescribeLogGroupsRequest.Builder builder()
public static Class<? extends DescribeLogGroupsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.