software.amazon.awssdk.services.route53resolver.model

Class ListResolverQueryLogConfigsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.route53resolver.model.Route53ResolverRequest

software.amazon.awssdk.services.route53resolver.model.ListResolverQueryLogConfigsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListResolverQueryLogConfigsRequest.Builder,ListResolverQueryLogConfigsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListResolverQueryLogConfigsRequest
extends Route53ResolverRequest
implements ToCopyableBuilder<ListResolverQueryLogConfigsRequest.Builder,ListResolverQueryLogConfigsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListResolverQueryLogConfigsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListResolverQueryLogConfigsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters() An optional specification to return a subset of query logging configurations.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Integer	maxResults() The maximum number of query logging configurations that you want to return in the response to a ListResolverQueryLogConfigs request.
String	nextToken() For the first ListResolverQueryLogConfigs request, omit this value.
List<SdkField<?>>	sdkFields()
static Class<? extends ListResolverQueryLogConfigsRequest.Builder>	serializableBuilderClass()
String	sortBy() The element that you want Resolver to sort query logging configurations by.
SortOrder	sortOrder() If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.
String	sortOrderAsString() If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.
ListResolverQueryLogConfigsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

maxResults

public final Integer maxResults()

The maximum number of query logging configurations that you want to return in the response to a ListResolverQueryLogConfigs request. If you don't specify a value for MaxResults, Resolver returns up to 100 query logging configurations.

Returns:

The maximum number of query logging configurations that you want to return in the response to a ListResolverQueryLogConfigs request. If you don't specify a value for MaxResults, Resolver returns up to 100 query logging configurations.

nextToken

public final String nextToken()

For the first ListResolverQueryLogConfigs request, omit this value.

If there are more than MaxResults query logging configurations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.

Returns:

For the first ListResolverQueryLogConfigs request, omit this value.

If there are more than MaxResults query logging configurations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters 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.

filters

public final List<Filter> filters()

An optional specification to return a subset of query logging configurations.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

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

Returns:

An optional specification to return a subset of query logging configurations.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

sortBy

public final String sortBy()

The element that you want Resolver to sort query logging configurations by.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.

Valid values include the following elements:

• Arn: The ARN of the query logging configuration

• AssociationCount: The number of VPCs that are associated with the specified configuration

• CreationTime: The date and time that Resolver returned when the configuration was created

• CreatorRequestId: The value that was specified for CreatorRequestId when the configuration was created

• DestinationArn: The location that logs are sent to

• Id: The ID of the configuration

• Name: The name of the configuration

• OwnerId: The Amazon Web Services account number of the account that created the configuration

• ShareStatus: Whether the configuration is shared with other Amazon Web Services accounts or shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

• Status: The current status of the configuration. Valid values include the following:

  • CREATING: Resolver is creating the query logging configuration.

  • CREATED: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.

  • DELETING: Resolver is deleting this query logging configuration.

  • FAILED: Resolver either couldn't create or couldn't delete the query logging configuration. Here are two common causes:

    • The specified destination (for example, an Amazon S3 bucket) was deleted.

    • Permissions don't allow sending logs to the destination.

Returns:

The element that you want Resolver to sort query logging configurations by.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.

Valid values include the following elements:

• Arn: The ARN of the query logging configuration

• AssociationCount: The number of VPCs that are associated with the specified configuration

• CreationTime: The date and time that Resolver returned when the configuration was created

• CreatorRequestId: The value that was specified for CreatorRequestId when the configuration was created

• DestinationArn: The location that logs are sent to

• Id: The ID of the configuration

• Name: The name of the configuration

• OwnerId: The Amazon Web Services account number of the account that created the configuration

• ShareStatus: Whether the configuration is shared with other Amazon Web Services accounts or shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

• Status: The current status of the configuration. Valid values include the following:

  • CREATING: Resolver is creating the query logging configuration.

  • CREATED: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.

  • DELETING: Resolver is deleting this query logging configuration.

  • FAILED: Resolver either couldn't create or couldn't delete the query logging configuration. Here are two common causes:

    • The specified destination (for example, an Amazon S3 bucket) was deleted.

    • Permissions don't allow sending logs to the destination.

sortOrder

public final SortOrder sortOrder()

If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.

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

Returns:

If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.

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

Returns:

If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.

See Also:

SortOrder

toBuilder

public ListResolverQueryLogConfigsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListResolverQueryLogConfigsRequest.Builder,ListResolverQueryLogConfigsRequest>

Specified by:

toBuilder in class Route53ResolverRequest

builder

public static ListResolverQueryLogConfigsRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo