Class TrustedAccessProgramSummary

java.lang.Object
software.amazon.awssdk.services.bedrock.model.TrustedAccessProgramSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TrustedAccessProgramSummary.Builder,TrustedAccessProgramSummary>

@Generated("software.amazon.awssdk:codegen") public final class TrustedAccessProgramSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TrustedAccessProgramSummary.Builder,TrustedAccessProgramSummary>

Program details and participation resolved for the calling account and optional named project.

See Also:
  • Method Details

    • programId

      public final String programId()

      Identifier of the trusted access program.

      Returns:
      Identifier of the trusted access program.
    • name

      public final String name()

      Display name of the program.

      Returns:
      Display name of the program.
    • description

      public final String description()

      Description of the program and its effects on model access or data handling.

      Returns:
      Description of the program and its effects on model access or data handling.
    • providerName

      public final String providerName()

      Name of the model provider offering the program.

      Returns:
      Name of the model provider offering the program.
    • detailsUrl

      public final String detailsUrl()

      URL with program details, terms, and instructions for obtaining access.

      Returns:
      URL with program details, terms, and instructions for obtaining access.
    • enrollmentUrl

      public final String enrollmentUrl()

      Provider application intake URL. Omitted when the program has no customer-facing intake URL.

      Returns:
      Provider application intake URL. Omitted when the program has no customer-facing intake URL.
    • status

      public final TrustedAccessProgramStatus status()

      Participation status resolved for the account and optional project context.

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

      Returns:
      Participation status resolved for the account and optional project context.
      See Also:
    • statusAsString

      public final String statusAsString()

      Participation status resolved for the account and optional project context.

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

      Returns:
      Participation status resolved for the account and optional project context.
      See Also:
    • statusReason

      public final String statusReason()

      Nonempty explanation for requestable or revoked status. Omitted for other statuses.

      Returns:
      Nonempty explanation for requestable or revoked status. Omitted for other statuses.
    • source

      public final TrustedAccessProgramScope source()

      Scope deciding the status. This can differ from the scope supplying the resolved opt-in preference and enrollment timestamps.

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

      Returns:
      Scope deciding the status. This can differ from the scope supplying the resolved opt-in preference and enrollment timestamps.
      See Also:
    • sourceAsString

      public final String sourceAsString()

      Scope deciding the status. This can differ from the scope supplying the resolved opt-in preference and enrollment timestamps.

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

      Returns:
      Scope deciding the status. This can differ from the scope supplying the resolved opt-in preference and enrollment timestamps.
      See Also:
    • eligibilityScope

      public final TrustedAccessProgramScope eligibilityScope()

      Scope supplying the applicable approval or most-specific revocation. Omitted when no approval or revocation applies.

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

      Returns:
      Scope supplying the applicable approval or most-specific revocation. Omitted when no approval or revocation applies.
      See Also:
    • eligibilityScopeAsString

      public final String eligibilityScopeAsString()

      Scope supplying the applicable approval or most-specific revocation. Omitted when no approval or revocation applies.

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

      Returns:
      Scope supplying the applicable approval or most-specific revocation. Omitted when no approval or revocation applies.
      See Also:
    • resolvedFor

      public final TrustedAccessResolutionContext resolvedFor()

      Account and optional project context for which participation was resolved.

      Returns:
      Account and optional project context for which participation was resolved.
    • optIn

      public final TrustedAccessProgramOptIn optIn()

      Resolved customer preference, preserved independently of eligibility, including while revoked.

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

      Returns:
      Resolved customer preference, preserved independently of eligibility, including while revoked.
      See Also:
    • optInAsString

      public final String optInAsString()

      Resolved customer preference, preserved independently of eligibility, including while revoked.

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

      Returns:
      Resolved customer preference, preserved independently of eligibility, including while revoked.
      See Also:
    • updatedAt

      public final Instant updatedAt()

      Last change to the enrollment supplying the resolved opt-in. Present for enabled or disabled, including while revoked; omitted for inherit.

      Returns:
      Last change to the enrollment supplying the resolved opt-in. Present for enabled or disabled, including while revoked; omitted for inherit.
    • 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<TrustedAccessProgramSummary.Builder,TrustedAccessProgramSummary>
      Returns:
      a builder for type T
    • builder

      public static TrustedAccessProgramSummary.Builder builder()
    • serializableBuilderClass

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

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

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.