Class CreatePortalRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>

@Generated("software.amazon.awssdk:codegen") public final class CreatePortalRequest extends ApiPortalRequest implements ToCopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>
  • Method Details

    • portalContent

      public final PortalContent portalContent()

      The portal's display name, description, and theme.

      Returns:
      The portal's display name, description, and theme.
    • endpointConfiguration

      public final EndpointConfigurationRequest endpointConfiguration()
      Returns the value of the EndpointConfiguration property for this object.
      Returns:
      The value of the EndpointConfiguration property for this object.
    • authorization

      public final Authorization 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.
    • 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 the isEmpty() 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

      public final List<String> includedProductArns()

      The ARNs of the products the portal includes, up to 200.

      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, up to 200.
    • logoUri

      public final String logoUri()

      The S3 location of the portal logo, in the form s3://bucket/key.

      Returns:
      The S3 location of the portal logo, in the form s3://bucket/key.
    • rumAppMonitorName

      public final String 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.
    • 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 the isEmpty() 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

      public final Map<String,String> 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

      public CreatePortalRequest.Builder 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 interface ToCopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>
      Specified by:
      toBuilder in class ApiPortalRequest
      Returns:
      a builder for type T
    • builder

      public static CreatePortalRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends CreatePortalRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String 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.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.