Class CreateProductApiPageResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateProductApiPageResponse.Builder,CreateProductApiPageResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal ApiIdapiId()The API the page documents.builder()The content shown on the page.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 extendsSdkResponse.final inthashCode()final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final StringThe ARN of the API page.final StringThe identifier of the API page.static Class<? extends CreateProductApiPageResponse.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.tags()Returns the value of the Tags 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 class software.amazon.awssdk.services.apiportal.model.ApiPortalResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods 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
-
displayContent
The content shown on the page.
- Returns:
- The content shown on the page.
-
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.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
tags
Returns the value of the Tags property for this object.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
hasTags()method.- Returns:
- The value of the Tags 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<CreateProductApiPageResponse.Builder,CreateProductApiPageResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsResponse
-
equals
- Overrides:
equalsin classAwsResponse
-
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:SdkResponseUsed to retrieve the value of a field from any class that extendsSdkResponse. 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, theSdkResponse.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkResponse- 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.
-