Class GetConsentPortalResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.bedrockagentcorecontrol.model.BedrockAgentCoreControlResponse
software.amazon.awssdk.services.bedrockagentcorecontrol.model.GetConsentPortalResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetConsentPortalResponse.Builder,GetConsentPortalResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetConsentPortalResponse extends BedrockAgentCoreControlResponse implements ToCopyableBuilder<GetConsentPortalResponse.Builder,GetConsentPortalResponse>

  • Method Details

    • hasSources

      public final boolean hasSources()
      For responses, this returns true if the service returned a value for the Sources 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.

    • sources

      public final List<ConsentPortalSource> sources()

      The resources served by the consent portal.

      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 hasSources() method.

      Returns:
      The resources served by the consent portal.

    • consentPortalArn

      public final String consentPortalArn()

      The Amazon Resource Name (ARN) of the consent portal.

      Returns:
      The Amazon Resource Name (ARN) of the consent portal.

    • consentPortalId

      public final String consentPortalId()

      The unique identifier of the consent portal.

      Returns:
      The unique identifier of the consent portal.

    • createdAt

      public final Instant createdAt()

      The timestamp for when the consent portal was created.

      Returns:
      The timestamp for when the consent portal was created.

    • description

      public final String description()

      The description of the consent portal.

      Returns:
      The description of the consent portal.

    • executionRoleArn

      public final String executionRoleArn()

      The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.

    • idpConfig

      public final ConsentPortalIdpConfig idpConfig()

      The identity provider configuration that the consent portal uses to authenticate end users.

      Returns:
      The identity provider configuration that the consent portal uses to authenticate end users.

    • name

      public final String name()

      The name of the consent portal.

      Returns:
      The name of the consent portal.

    • portalUrl

      public final String portalUrl()

      The URL used to access the consent portal.

      Returns:
      The URL used to access the consent portal.

    • status

      public final ConsentPortalStatus status()

      The current status of the consent portal.

      If the service returns an enum value that is not available in the current SDK version, status will return ConsentPortalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the consent portal.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the consent portal.

      If the service returns an enum value that is not available in the current SDK version, status will return ConsentPortalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the consent portal.
      See Also:

    • statusReason

      public final String statusReason()

      A message that provides additional information about the current status of the consent portal.

      Returns:
      A message that provides additional information about the current status of the consent portal.

    • updatedAt

      public final Instant updatedAt()

      The timestamp for when the consent portal was last updated.

      Returns:
      The timestamp for when the consent portal was last updated.

    • toBuilder

      public GetConsentPortalResponse.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<GetConsentPortalResponse.Builder,GetConsentPortalResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetConsentPortalResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetConsentPortalResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.