Class GetProductApiPageRequest
java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.apiportal.model.ApiPortalRequest
software.amazon.awssdk.services.apiportal.model.GetProductApiPageRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetProductApiPageRequest.Builder,GetProductApiPageRequest>
@Generated("software.amazon.awssdk:codegen")
public final class GetProductApiPageRequest
extends ApiPortalRequest
implements ToCopyableBuilder<GetProductApiPageRequest.Builder,GetProductApiPageRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final booleanfinal booleanequalsBySdkFields(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 inthashCode()final BooleanSet totrueto also return the page body inrawDisplayContent.final StringThe identifier of the API page.final StringThe identifier of the product.final StringThe AWS account ID that owns the product.static Class<? extends GetProductApiPageRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
productId
The identifier of the product.
- Returns:
- The identifier of the product.
-
productApiPageId
The identifier of the API page.
- Returns:
- The identifier of the API page.
-
resourceOwnerAccountId
The AWS account ID that owns the product. Supply it to read a product shared with you by another account. Omit it for products in your own account.
- Returns:
- The AWS account ID that owns the product. Supply it to read a product shared with you by another account. Omit it for products in your own account.
-
includeRawDisplayContent
Set to
trueto also return the page body inrawDisplayContent.- Returns:
- Set to
trueto also return the page body inrawDisplayContent.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GetProductApiPageRequest.Builder,GetProductApiPageRequest> - Specified by:
toBuilderin classApiPortalRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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
-
getValueForField
Description copied from class:SdkRequestUsed 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:
getValueForFieldin 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-