Class Api

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

Describes an AppSync API. You can use Api for an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

See Also:

  • Method Details

    • apiId

      public final String apiId()

      The Api ID.

      Returns:
      The Api ID.

    • name

      public final String name()

      The name of the Api.

      Returns:
      The name of the Api.

    • ownerContact

      public final String ownerContact()

      The owner contact information for the Api

      Returns:
      The owner contact information for the Api

    • 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.

    • hasDns

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

    • dns

      public final Map<String,String> dns()

      The DNS records for the API. This will include an HTTP and a real-time endpoint.

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

      Returns:
      The DNS records for the API. This will include an HTTP and a real-time endpoint.

    • apiArn

      public final String apiArn()

      The Amazon Resource Name (ARN) for the Api.

      Returns:
      The Amazon Resource Name (ARN) for the Api.

    • created

      public final Instant created()

      The date and time that the Api was created.

      Returns:
      The date and time that the Api was created.

    • xrayEnabled

      public final Boolean xrayEnabled()

      A flag indicating whether to use X-Ray tracing for this Api.

      Returns:
      A flag indicating whether to use X-Ray tracing for this Api.

    • wafWebAclArn

      public final String wafWebAclArn()

      The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this Api , if one exists.

      Returns:
      The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this Api, if one exists.

    • eventConfig

      public final EventConfig eventConfig()

      The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

      Returns:
      The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

    • toBuilder

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

    • builder

      public static Api.Builder builder()

    • serializableBuilderClass

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