Package software.amazon.awssdk.services.appsync.model

Class SourceApiAssociation

java.lang.Object
software.amazon.awssdk.services.appsync.model.SourceApiAssociation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SourceApiAssociation.Builder,SourceApiAssociation>
@Generated("software.amazon.awssdk:codegen") public final class SourceApiAssociation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SourceApiAssociation.Builder,SourceApiAssociation>

Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API. There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular API.

Source APIs can originate from your account or from other accounts via Amazon Web Services Resource Access Manager. For more information about sharing resources from other accounts, see What is Amazon Web Services Resource Access Manager? in the Amazon Web Services Resource Access Manager guide.

See Also:

  • Method Details

    • associationId

      public final String associationId()

      The ID generated by the AppSync service for the source API association.

      Returns:
      The ID generated by the AppSync service for the source API association.

    • associationArn

      public final String associationArn()

      The Amazon Resource Name (ARN) of the source API association.

      Returns:
      The Amazon Resource Name (ARN) of the source API association.

    • sourceApiId

      public final String sourceApiId()

      The ID of the AppSync source API.

      Returns:
      The ID of the AppSync source API.

    • sourceApiArn

      public final String sourceApiArn()

      The Amazon Resource Name (ARN) of the AppSync source API.

      Returns:
      The Amazon Resource Name (ARN) of the AppSync source API.

    • mergedApiArn

      public final String mergedApiArn()

      The Amazon Resource Name (ARN) of the AppSync Merged API.

      Returns:
      The Amazon Resource Name (ARN) of the AppSync Merged API.

    • mergedApiId

      public final String mergedApiId()

      The ID of the AppSync Merged API.

      Returns:
      The ID of the AppSync Merged API.

    • description

      public final String description()

      The description field.

      Returns:
      The description field.

    • sourceApiAssociationConfig

      public final SourceApiAssociationConfig sourceApiAssociationConfig()

      The SourceApiAssociationConfig object data.

      Returns:
      The SourceApiAssociationConfig object data.

    • sourceApiAssociationStatus

      public final SourceApiAssociationStatus sourceApiAssociationStatus()

      The state of the source API association.

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

      Returns:
      The state of the source API association.
      See Also:

    • sourceApiAssociationStatusAsString

      public final String sourceApiAssociationStatusAsString()

      The state of the source API association.

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

      Returns:
      The state of the source API association.
      See Also:

    • sourceApiAssociationStatusDetail

      public final String sourceApiAssociationStatusDetail()

      The detailed message related to the current state of the source API association.

      Returns:
      The detailed message related to the current state of the source API association.

    • lastSuccessfulMergeDate

      public final Instant lastSuccessfulMergeDate()

      The datetime value of the last successful merge of the source API association. The result will be in UTC format and your local time zone.

      Returns:
      The datetime value of the last successful merge of the source API association. The result will be in UTC format and your local time zone.

    • toBuilder

      public SourceApiAssociation.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<SourceApiAssociation.Builder,SourceApiAssociation>
      Returns:
      a builder for type T

    • builder

      public static SourceApiAssociation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SourceApiAssociation.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.