Class ProductApiPageSummaryNoBody
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ProductApiPageSummaryNoBody.Builder,ProductApiPageSummaryNoBody>
A summary of an API page, without its body.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal ApiIdapiId()The API the page documents.final StringapiUrl()The invoke URL shown on the page and used by Try-It.builder()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) final inthashCode()final StringThe operation name shown as the page title.final StringThe ARN of the API page.final StringThe identifier of the API page.static Class<? extends ProductApiPageSummaryNoBody.Builder> final Statusstatus()The status of the page content:IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED.final StringThe status of the page content:IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED.Returns the value of the StatusException property for this object.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.final TryItStateWhether Try-It is enabled on the page.final StringWhether Try-It is enabled on the page.final InstantWhen the resource was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
productApiPageId
The identifier of the API page.
- Returns:
- The identifier of the API page.
-
productApiPageArn
-
apiId
-
operationName
The operation name shown as the page title.
- Returns:
- The operation name shown as the page title.
-
apiUrl
The invoke URL shown on the page and used by Try-It.
- Returns:
- The invoke URL shown on the page and used by Try-It.
-
tryItState
Whether Try-It is enabled on the page.
If the service returns an enum value that is not available in the current SDK version,
tryItStatewill returnTryItState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtryItStateAsString().- Returns:
- Whether Try-It is enabled on the page.
- See Also:
-
tryItStateAsString
Whether Try-It is enabled on the page.
If the service returns an enum value that is not available in the current SDK version,
tryItStatewill returnTryItState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtryItStateAsString().- Returns:
- Whether Try-It is enabled on the page.
- See Also:
-
updatedAt
When the resource was last updated.
- Returns:
- When the resource was last updated.
-
status
The status of the page content:
IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED.If the service returns an enum value that is not available in the current SDK version,
statuswill returnStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the page content:
IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED. - See Also:
-
statusAsString
The status of the page content:
IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED.If the service returns an enum value that is not available in the current SDK version,
statuswill returnStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the page content:
IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED. - See Also:
-
statusException
Returns the value of the StatusException property for this object.- Returns:
- The value of the StatusException property for this object.
-
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<ProductApiPageSummaryNoBody.Builder,ProductApiPageSummaryNoBody> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
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
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-