GraphqlApi (AWS Java SDK :: Services :: AWS AppSync 2.16.76 API)

java.lang.Object
- software.amazon.awssdk.services.appsync.model.GraphqlApi

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<GraphqlApi.Builder,GraphqlApi>

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

Describes a GraphQL API.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GraphqlApi.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GraphqlApi.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AdditionalAuthenticationProvider>`	`additionalAuthenticationProviders()` A list of additional authentication providers for the `GraphqlApi` API.
`String`	`apiId()` The API ID.
`String`	`arn()` The ARN.
`AuthenticationType`	`authenticationType()` The authentication type.
`String`	`authenticationTypeAsString()` The authentication type.
`static GraphqlApi.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalAuthenticationProviders()` Returns true if the AdditionalAuthenticationProviders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUris()` Returns true if the Uris property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`LogConfig`	`logConfig()` The Amazon CloudWatch Logs configuration.
`String`	`name()` The API name.
`OpenIDConnectConfig`	`openIDConnectConfig()` The OpenID Connect configuration.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GraphqlApi.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` The tags.
`GraphqlApi.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Map<String,String>`	`uris()` The URIs.
`UserPoolConfig`	`userPoolConfig()` The Amazon Cognito user pool configuration.
`String`	`wafWebAclArn()` The ARN of the AWS Web Application Firewall (WAF) ACL associated with this `GraphqlApi`, if one exists.
`Boolean`	`xrayEnabled()` A flag representing whether X-Ray tracing is enabled for this `GraphqlApi`.

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
  - name
```
public final String name()
```
    The API name.
    
    Returns:
    
    The API name.
  - apiId
```
public final String apiId()
```
    The API ID.
    
    Returns:
    
    The API ID.
  - authenticationType
```
public final AuthenticationType authenticationType()
```
    The authentication type.
    
    If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().
    
    Returns:
    
    The authentication type.
    
    See Also:
    
    AuthenticationType
  - authenticationTypeAsString
```
public final String authenticationTypeAsString()
```
    The authentication type.
    
    If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().
    
    Returns:
    
    The authentication type.
    
    See Also:
    
    AuthenticationType
  - logConfig
```
public final LogConfig logConfig()
```
    The Amazon CloudWatch Logs configuration.
    
    Returns:
    
    The Amazon CloudWatch Logs configuration.
  - userPoolConfig
```
public final UserPoolConfig userPoolConfig()
```
    The Amazon Cognito user pool configuration.
    
    Returns:
    
    The Amazon Cognito user pool configuration.
  - openIDConnectConfig
```
public final OpenIDConnectConfig openIDConnectConfig()
```
    The OpenID Connect configuration.
    
    Returns:
    
    The OpenID Connect configuration.
  - arn
```
public final String arn()
```
    The ARN.
    
    Returns:
    
    The ARN.
  - hasUris
```
public final boolean hasUris()
```
    Returns true if the Uris property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - uris
```
public final Map<String,String> uris()
```
    The URIs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUris() to see if a value was sent in this field.
    
    Returns:
    
    The URIs.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final Map<String,String> tags()
```
    The tags.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The tags.
  - hasAdditionalAuthenticationProviders
```
public final boolean hasAdditionalAuthenticationProviders()
```
    Returns true if the AdditionalAuthenticationProviders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - additionalAuthenticationProviders
```
public final List<AdditionalAuthenticationProvider> additionalAuthenticationProviders()
```
    A list of additional authentication providers for the GraphqlApi API.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAdditionalAuthenticationProviders() to see if a value was sent in this field.
    
    Returns:
    
    A list of additional authentication providers for the GraphqlApi API.
  - xrayEnabled
```
public final Boolean xrayEnabled()
```
    A flag representing whether X-Ray tracing is enabled for this GraphqlApi.
    
    Returns:
    
    A flag representing whether X-Ray tracing is enabled for this GraphqlApi.
  - wafWebAclArn
```
public final String wafWebAclArn()
```
    The ARN of the AWS Web Application Firewall (WAF) ACL associated with this GraphqlApi, if one exists.
    
    Returns:
    
    The ARN of the AWS Web Application Firewall (WAF) ACL associated with this GraphqlApi, if one exists.
  - toBuilder
```
public GraphqlApi.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GraphqlApi.Builder,GraphqlApi>
  - builder
```
public static GraphqlApi.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GraphqlApi.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

Class GraphqlApi

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

apiId

authenticationType

authenticationTypeAsString

logConfig

userPoolConfig

openIDConnectConfig

arn

hasUris

uris

hasTags

tags

hasAdditionalAuthenticationProviders

additionalAuthenticationProviders

xrayEnabled

wafWebAclArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields