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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Api.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`apiArn()`	The Amazon Resource Name (ARN) for the `Api`.
`String`	`apiId()`	The `Api` ID.
`static Api.Builder`	`builder()`
`Instant`	`created()`	The date and time that the `Api` was created.
`Map<String,String>`	`dns()`	The DNS records for the API.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`EventConfig`	`eventConfig()`	The Event API configuration.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDns()`	For responses, this returns true if the service returned a value for the Dns property.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`name()`	The name of the `Api`.
`String`	`ownerContact()`	The owner contact information for the `Api`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Api.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`	Returns the value of the Tags property for this object.
`Api.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`wafWebAclArn()`	The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this `Api` , if one exists.
`Boolean`	`xrayEnabled()`	A flag indicating whether to use X-Ray tracing for this `Api`.

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
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Api.Builder,Api>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Api

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

apiId

name

ownerContact

hasTags

tags

hasDns

dns

apiArn

created

xrayEnabled

wafWebAclArn

eventConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField