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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
SourceApiAssociation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
associationArn()
The Amazon Resource Name (ARN) of the source API association.String
associationId()
The ID generated by the AppSync service for the source API association.static SourceApiAssociation.Builder
builder()
String
description()
The description field.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Instant
lastSuccessfulMergeDate()
The datetime value of the last successful merge of the source API association.String
mergedApiArn()
The Amazon Resource Name (ARN) of the AppSync Merged API.String
mergedApiId()
The ID of the AppSync Merged API.List<SdkField<?>>
sdkFields()
static Class<? extends SourceApiAssociation.Builder>
serializableBuilderClass()
String
sourceApiArn()
The Amazon Resource Name (ARN) of the AppSync source API.SourceApiAssociationConfig
sourceApiAssociationConfig()
TheSourceApiAssociationConfig
object data.SourceApiAssociationStatus
sourceApiAssociationStatus()
The state of the source API association.String
sourceApiAssociationStatusAsString()
The state of the source API association.String
sourceApiAssociationStatusDetail()
The detailed message related to the current state of the source API association.String
sourceApiId()
The ID of the AppSync source API.SourceApiAssociation.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 returnSourceApiAssociationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceApiAssociationStatusAsString()
.- Returns:
- The state of the source API association.
- See Also:
SourceApiAssociationStatus
-
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 returnSourceApiAssociationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceApiAssociationStatusAsString()
.- Returns:
- The state of the source API association.
- See Also:
SourceApiAssociationStatus
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<SourceApiAssociation.Builder,SourceApiAssociation>
-
builder
public static SourceApiAssociation.Builder builder()
-
serializableBuilderClass
public static Class<? extends SourceApiAssociation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-