Class GetPortalResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetPortalResponse.Builder,GetPortalResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AuthorizationHow readers sign in to the portal, and whether fine-grained access control is on.static GetPortalResponse.Builderbuilder()The domain configuration of the portal.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 booleanFor responses, this returns true if the service returned a value for the IncludedProductArns property.final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.The ARNs of the products the portal includes.final StringThe ARN of the portal.final PortalContentThe portal's display name, description, and theme.final StringportalId()The identifier of the portal.final Previewpreview()The most recent preview of the portal.final StringThe description supplied with the most recent publish request.final InstantWhen the portal was last published.final PublishStatusThe publish status of the portal.final StringThe publish status of the portal.final StringThe name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.static Class<? extends GetPortalResponse.Builder> final PortalStatusExceptionReturns 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 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
-
portalId
-
portalArn
-
endpointConfiguration
The domain configuration of the portal.
- Returns:
- The domain configuration of the portal.
-
authorization
How readers sign in to the portal, and whether fine-grained access control is on.
- Returns:
- How readers sign in to the portal, and whether fine-grained access control is on.
-
portalContent
The portal's display name, description, and theme.
- Returns:
- The portal's display name, description, and theme.
-
hasIncludedProductArns
public final boolean hasIncludedProductArns()For responses, this returns true if the service returned a value for the IncludedProductArns 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. -
includedProductArns
The ARNs of the products the portal includes.
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
hasIncludedProductArns()method.- Returns:
- The ARNs of the products the portal includes.
-
publishStatus
The publish status of the portal. Absent if the portal has never been published.
If the service returns an enum value that is not available in the current SDK version,
publishStatuswill returnPublishStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompublishStatusAsString().- Returns:
- The publish status of the portal. Absent if the portal has never been published.
- See Also:
-
publishStatusAsString
The publish status of the portal. Absent if the portal has never been published.
If the service returns an enum value that is not available in the current SDK version,
publishStatuswill returnPublishStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompublishStatusAsString().- Returns:
- The publish status of the portal. Absent if the portal has never been published.
- See Also:
-
statusException
Returns the value of the StatusException property for this object.- Returns:
- The value of the StatusException property for this object.
-
updatedAt
When the resource was last updated.
- Returns:
- When the resource was last updated.
-
publishedAt
When the portal was last published.
- Returns:
- When the portal was last published.
-
publishDescription
The description supplied with the most recent publish request.
- Returns:
- The description supplied with the most recent publish request.
-
rumAppMonitorName
The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.
- Returns:
- The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.
-
preview
The most recent preview of the portal. Absent if no preview has been created.
- Returns:
- The most recent preview of the portal. Absent if no preview has been created.
-
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<GetPortalResponse.Builder,GetPortalResponse> - 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.
-