Class ListRuleGroupsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListRuleGroupsRequest.Builder,
ListRuleGroupsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
limit()
The maximum number of objects that you want WAF to return for this request.final String
When you request a list of objects with aLimit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response.final Scope
scope()
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.final String
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.static Class
<? extends ListRuleGroupsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
If the service returns an enum value that is not available in the current SDK version,
scope
will returnScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscopeAsString()
.- Returns:
- Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional
application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL
API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access
instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
- See Also:
-
-
scopeAsString
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
If the service returns an enum value that is not available in the current SDK version,
scope
will returnScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscopeAsString()
.- Returns:
- Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional
application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL
API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access
instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
- See Also:
-
-
nextMarker
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.- Returns:
- When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
-
limit
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects.- Returns:
- The maximum number of objects that you want WAF to return for this request. If more objects are
available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects.
-
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 interfaceToCopyableBuilder<ListRuleGroupsRequest.Builder,
ListRuleGroupsRequest> - Specified by:
toBuilder
in classWafv2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-