GraphqlApi (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.appsync.model.GraphqlApi

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GraphqlApi
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a GraphQL API.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GraphqlApi()

Constructors
Constructor and Description
`GraphqlApi()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GraphqlApi`	`addDnsEntry(String key, String value)` Add a single Dns entry
`GraphqlApi`	`addTagsEntry(String key, String value)` Add a single Tags entry
`GraphqlApi`	`addUrisEntry(String key, String value)` Add a single Uris entry
`GraphqlApi`	`clearDnsEntries()` Removes all the entries added into Dns.
`GraphqlApi`	`clearTagsEntries()` Removes all the entries added into Tags.
`GraphqlApi`	`clearUrisEntries()` Removes all the entries added into Uris.
`GraphqlApi`	`clone()`
`boolean`	`equals(Object obj)`
`List<AdditionalAuthenticationProvider>`	`getAdditionalAuthenticationProviders()` A list of additional authentication providers for the `GraphqlApi` API.
`String`	`getApiId()` The API ID.
`String`	`getApiType()` The value that indicates whether the GraphQL API is a standard API (`GRAPHQL`) or merged API ( `MERGED`).
`String`	`getArn()` The Amazon Resource Name (ARN).
`String`	`getAuthenticationType()` The authentication type.
`Map<String,String>`	`getDns()` The DNS records for the API.
`EnhancedMetricsConfig`	`getEnhancedMetricsConfig()` The `enhancedMetricsConfig` object.
`String`	`getIntrospectionConfig()` Sets the value of the GraphQL API to enable (`ENABLED`) or disable (`DISABLED`) introspection.
`LambdaAuthorizerConfig`	`getLambdaAuthorizerConfig()` Configuration for Lambda function authorization.
`LogConfig`	`getLogConfig()` The Amazon CloudWatch Logs configuration.
`String`	`getMergedApiExecutionRoleArn()` The Identity and Access Management service role ARN for a merged API.
`String`	`getName()` The API name.
`OpenIDConnectConfig`	`getOpenIDConnectConfig()` The OpenID Connect configuration.
`String`	`getOwner()` The account owner of the GraphQL API.
`String`	`getOwnerContact()` The owner contact information for an API resource.
`Integer`	`getQueryDepthLimit()` The maximum depth a query can have in a single request.
`Integer`	`getResolverCountLimit()` The maximum number of resolvers that can be invoked in a single request.
`Map<String,String>`	`getTags()` The tags.
`Map<String,String>`	`getUris()` The URIs.
`UserPoolConfig`	`getUserPoolConfig()` The Amazon Cognito user pool configuration.
`String`	`getVisibility()` Sets the value of the GraphQL API to public (`GLOBAL`) or private (`PRIVATE`).
`String`	`getWafWebAclArn()` The ARN of the WAF access control list (ACL) associated with this `GraphqlApi`, if one exists.
`Boolean`	`getXrayEnabled()` A flag indicating whether to use X-Ray tracing for this `GraphqlApi`.
`int`	`hashCode()`
`Boolean`	`isXrayEnabled()` A flag indicating whether to use X-Ray tracing for this `GraphqlApi`.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders)` A list of additional authentication providers for the `GraphqlApi` API.
`void`	`setApiId(String apiId)` The API ID.
`void`	`setApiType(String apiType)` The value that indicates whether the GraphQL API is a standard API (`GRAPHQL`) or merged API ( `MERGED`).
`void`	`setArn(String arn)` The Amazon Resource Name (ARN).
`void`	`setAuthenticationType(String authenticationType)` The authentication type.
`void`	`setDns(Map<String,String> dns)` The DNS records for the API.
`void`	`setEnhancedMetricsConfig(EnhancedMetricsConfig enhancedMetricsConfig)` The `enhancedMetricsConfig` object.
`void`	`setIntrospectionConfig(String introspectionConfig)` Sets the value of the GraphQL API to enable (`ENABLED`) or disable (`DISABLED`) introspection.
`void`	`setLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)` Configuration for Lambda function authorization.
`void`	`setLogConfig(LogConfig logConfig)` The Amazon CloudWatch Logs configuration.
`void`	`setMergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)` The Identity and Access Management service role ARN for a merged API.
`void`	`setName(String name)` The API name.
`void`	`setOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)` The OpenID Connect configuration.
`void`	`setOwner(String owner)` The account owner of the GraphQL API.
`void`	`setOwnerContact(String ownerContact)` The owner contact information for an API resource.
`void`	`setQueryDepthLimit(Integer queryDepthLimit)` The maximum depth a query can have in a single request.
`void`	`setResolverCountLimit(Integer resolverCountLimit)` The maximum number of resolvers that can be invoked in a single request.
`void`	`setTags(Map<String,String> tags)` The tags.
`void`	`setUris(Map<String,String> uris)` The URIs.
`void`	`setUserPoolConfig(UserPoolConfig userPoolConfig)` The Amazon Cognito user pool configuration.
`void`	`setVisibility(String visibility)` Sets the value of the GraphQL API to public (`GLOBAL`) or private (`PRIVATE`).
`void`	`setWafWebAclArn(String wafWebAclArn)` The ARN of the WAF access control list (ACL) associated with this `GraphqlApi`, if one exists.
`void`	`setXrayEnabled(Boolean xrayEnabled)` A flag indicating whether to use X-Ray tracing for this `GraphqlApi`.
`String`	`toString()` Returns a string representation of this object.
`GraphqlApi`	`withAdditionalAuthenticationProviders(AdditionalAuthenticationProvider... additionalAuthenticationProviders)` A list of additional authentication providers for the `GraphqlApi` API.
`GraphqlApi`	`withAdditionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders)` A list of additional authentication providers for the `GraphqlApi` API.
`GraphqlApi`	`withApiId(String apiId)` The API ID.
`GraphqlApi`	`withApiType(GraphQLApiType apiType)` The value that indicates whether the GraphQL API is a standard API (`GRAPHQL`) or merged API ( `MERGED`).
`GraphqlApi`	`withApiType(String apiType)` The value that indicates whether the GraphQL API is a standard API (`GRAPHQL`) or merged API ( `MERGED`).
`GraphqlApi`	`withArn(String arn)` The Amazon Resource Name (ARN).
`GraphqlApi`	`withAuthenticationType(AuthenticationType authenticationType)` The authentication type.
`GraphqlApi`	`withAuthenticationType(String authenticationType)` The authentication type.
`GraphqlApi`	`withDns(Map<String,String> dns)` The DNS records for the API.
`GraphqlApi`	`withEnhancedMetricsConfig(EnhancedMetricsConfig enhancedMetricsConfig)` The `enhancedMetricsConfig` object.
`GraphqlApi`	`withIntrospectionConfig(GraphQLApiIntrospectionConfig introspectionConfig)` Sets the value of the GraphQL API to enable (`ENABLED`) or disable (`DISABLED`) introspection.
`GraphqlApi`	`withIntrospectionConfig(String introspectionConfig)` Sets the value of the GraphQL API to enable (`ENABLED`) or disable (`DISABLED`) introspection.
`GraphqlApi`	`withLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)` Configuration for Lambda function authorization.
`GraphqlApi`	`withLogConfig(LogConfig logConfig)` The Amazon CloudWatch Logs configuration.
`GraphqlApi`	`withMergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)` The Identity and Access Management service role ARN for a merged API.
`GraphqlApi`	`withName(String name)` The API name.
`GraphqlApi`	`withOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)` The OpenID Connect configuration.
`GraphqlApi`	`withOwner(String owner)` The account owner of the GraphQL API.
`GraphqlApi`	`withOwnerContact(String ownerContact)` The owner contact information for an API resource.
`GraphqlApi`	`withQueryDepthLimit(Integer queryDepthLimit)` The maximum depth a query can have in a single request.
`GraphqlApi`	`withResolverCountLimit(Integer resolverCountLimit)` The maximum number of resolvers that can be invoked in a single request.
`GraphqlApi`	`withTags(Map<String,String> tags)` The tags.
`GraphqlApi`	`withUris(Map<String,String> uris)` The URIs.
`GraphqlApi`	`withUserPoolConfig(UserPoolConfig userPoolConfig)` The Amazon Cognito user pool configuration.
`GraphqlApi`	`withVisibility(GraphQLApiVisibility visibility)` Sets the value of the GraphQL API to public (`GLOBAL`) or private (`PRIVATE`).
`GraphqlApi`	`withVisibility(String visibility)` Sets the value of the GraphQL API to public (`GLOBAL`) or private (`PRIVATE`).
`GraphqlApi`	`withWafWebAclArn(String wafWebAclArn)` The ARN of the WAF access control list (ACL) associated with this `GraphqlApi`, if one exists.
`GraphqlApi`	`withXrayEnabled(Boolean xrayEnabled)` A flag indicating whether to use X-Ray tracing for this `GraphqlApi`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GraphqlApi
```
public GraphqlApi()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The API name.
    
    Parameters:
    
    name - The API name.
  - getName
```
public String getName()
```
    The API name.
    
    Returns:
    
    The API name.
  - withName
```
public GraphqlApi withName(String name)
```
    The API name.
    
    Parameters:
    
    name - The API name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApiId
```
public void setApiId(String apiId)
```
    The API ID.
    
    Parameters:
    
    apiId - The API ID.
  - getApiId
```
public String getApiId()
```
    The API ID.
    
    Returns:
    
    The API ID.
  - withApiId
```
public GraphqlApi withApiId(String apiId)
```
    The API ID.
    
    Parameters:
    
    apiId - The API ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthenticationType
```
public void setAuthenticationType(String authenticationType)
```
    The authentication type.
    
    Parameters:
    
    authenticationType - The authentication type.
    
    See Also:
    
    AuthenticationType
  - getAuthenticationType
```
public String getAuthenticationType()
```
    The authentication type.
    
    Returns:
    
    The authentication type.
    
    See Also:
    
    AuthenticationType
  - withAuthenticationType
```
public GraphqlApi withAuthenticationType(String authenticationType)
```
    The authentication type.
    
    Parameters:
    
    authenticationType - The authentication type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthenticationType
  - withAuthenticationType
```
public GraphqlApi withAuthenticationType(AuthenticationType authenticationType)
```
    The authentication type.
    
    Parameters:
    
    authenticationType - The authentication type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthenticationType
  - setLogConfig
```
public void setLogConfig(LogConfig logConfig)
```
    The Amazon CloudWatch Logs configuration.
    
    Parameters:
    
    logConfig - The Amazon CloudWatch Logs configuration.
  - getLogConfig
```
public LogConfig getLogConfig()
```
    The Amazon CloudWatch Logs configuration.
    
    Returns:
    
    The Amazon CloudWatch Logs configuration.
  - withLogConfig
```
public GraphqlApi withLogConfig(LogConfig logConfig)
```
    The Amazon CloudWatch Logs configuration.
    
    Parameters:
    
    logConfig - The Amazon CloudWatch Logs configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserPoolConfig
```
public void setUserPoolConfig(UserPoolConfig userPoolConfig)
```
    The Amazon Cognito user pool configuration.
    
    Parameters:
    
    userPoolConfig - The Amazon Cognito user pool configuration.
  - getUserPoolConfig
```
public UserPoolConfig getUserPoolConfig()
```
    The Amazon Cognito user pool configuration.
    
    Returns:
    
    The Amazon Cognito user pool configuration.
  - withUserPoolConfig
```
public GraphqlApi withUserPoolConfig(UserPoolConfig userPoolConfig)
```
    The Amazon Cognito user pool configuration.
    
    Parameters:
    
    userPoolConfig - The Amazon Cognito user pool configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOpenIDConnectConfig
```
public void setOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)
```
    The OpenID Connect configuration.
    
    Parameters:
    
    openIDConnectConfig - The OpenID Connect configuration.
  - getOpenIDConnectConfig
```
public OpenIDConnectConfig getOpenIDConnectConfig()
```
    The OpenID Connect configuration.
    
    Returns:
    
    The OpenID Connect configuration.
  - withOpenIDConnectConfig
```
public GraphqlApi withOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)
```
    The OpenID Connect configuration.
    
    Parameters:
    
    openIDConnectConfig - The OpenID Connect configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN).
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN).
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN).
    
    Returns:
    
    The Amazon Resource Name (ARN).
  - withArn
```
public GraphqlApi withArn(String arn)
```
    The Amazon Resource Name (ARN).
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUris
```
public Map<String,String> getUris()
```
    The URIs.
    
    Returns:
    
    The URIs.
  - setUris
```
public void setUris(Map<String,String> uris)
```
    The URIs.
    
    Parameters:
    
    uris - The URIs.
  - withUris
```
public GraphqlApi withUris(Map<String,String> uris)
```
    The URIs.
    
    Parameters:
    
    uris - The URIs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addUrisEntry
```
public GraphqlApi addUrisEntry(String key,
                               String value)
```
    Add a single Uris entry
    
    See Also:
    
    withUris(java.util.Map<java.lang.String, java.lang.String>)
  - clearUrisEntries
```
public GraphqlApi clearUrisEntries()
```
    Removes all the entries added into Uris.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags.
    
    Returns:
    
    The tags.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags.
    
    Parameters:
    
    tags - The tags.
  - withTags
```
public GraphqlApi withTags(Map<String,String> tags)
```
    The tags.
    
    Parameters:
    
    tags - The tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public GraphqlApi addTagsEntry(String key,
                               String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public GraphqlApi clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdditionalAuthenticationProviders
```
public List<AdditionalAuthenticationProvider> getAdditionalAuthenticationProviders()
```
    A list of additional authentication providers for the GraphqlApi API.
    
    Returns:
    
    A list of additional authentication providers for the GraphqlApi API.
  - setAdditionalAuthenticationProviders
```
public void setAdditionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders)
```
    A list of additional authentication providers for the GraphqlApi API.
    
    Parameters:
    
    additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.
  - withAdditionalAuthenticationProviders
```
public GraphqlApi withAdditionalAuthenticationProviders(AdditionalAuthenticationProvider... additionalAuthenticationProviders)
```
    A list of additional authentication providers for the GraphqlApi API.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdditionalAuthenticationProviders(java.util.Collection) or withAdditionalAuthenticationProviders(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdditionalAuthenticationProviders
```
public GraphqlApi withAdditionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders)
```
    A list of additional authentication providers for the GraphqlApi API.
    
    Parameters:
    
    additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setXrayEnabled
```
public void setXrayEnabled(Boolean xrayEnabled)
```
    A flag indicating whether to use X-Ray tracing for this GraphqlApi.
    
    Parameters:
    
    xrayEnabled - A flag indicating whether to use X-Ray tracing for this GraphqlApi.
  - getXrayEnabled
```
public Boolean getXrayEnabled()
```
    A flag indicating whether to use X-Ray tracing for this GraphqlApi.
    
    Returns:
    
    A flag indicating whether to use X-Ray tracing for this GraphqlApi.
  - withXrayEnabled
```
public GraphqlApi withXrayEnabled(Boolean xrayEnabled)
```
    A flag indicating whether to use X-Ray tracing for this GraphqlApi.
    
    Parameters:
    
    xrayEnabled - A flag indicating whether to use X-Ray tracing for this GraphqlApi.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isXrayEnabled
```
public Boolean isXrayEnabled()
```
    A flag indicating whether to use X-Ray tracing for this GraphqlApi.
    
    Returns:
    
    A flag indicating whether to use X-Ray tracing for this GraphqlApi.
  - setWafWebAclArn
```
public void setWafWebAclArn(String wafWebAclArn)
```
    The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.
    
    Parameters:
    
    wafWebAclArn - The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.
  - getWafWebAclArn
```
public String getWafWebAclArn()
```
    The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.
    
    Returns:
    
    The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.
  - withWafWebAclArn
```
public GraphqlApi withWafWebAclArn(String wafWebAclArn)
```
    The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.
    
    Parameters:
    
    wafWebAclArn - The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLambdaAuthorizerConfig
```
public void setLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)
```
    Configuration for Lambda function authorization.
    
    Parameters:
    
    lambdaAuthorizerConfig - Configuration for Lambda function authorization.
  - getLambdaAuthorizerConfig
```
public LambdaAuthorizerConfig getLambdaAuthorizerConfig()
```
    Configuration for Lambda function authorization.
    
    Returns:
    
    Configuration for Lambda function authorization.
  - withLambdaAuthorizerConfig
```
public GraphqlApi withLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)
```
    Configuration for Lambda function authorization.
    
    Parameters:
    
    lambdaAuthorizerConfig - Configuration for Lambda function authorization.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDns
```
public Map<String,String> getDns()
```
    The DNS records for the API.
    
    Returns:
    
    The DNS records for the API.
  - setDns
```
public void setDns(Map<String,String> dns)
```
    The DNS records for the API.
    
    Parameters:
    
    dns - The DNS records for the API.
  - withDns
```
public GraphqlApi withDns(Map<String,String> dns)
```
    The DNS records for the API.
    
    Parameters:
    
    dns - The DNS records for the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDnsEntry
```
public GraphqlApi addDnsEntry(String key,
                              String value)
```
    Add a single Dns entry
    
    See Also:
    
    withDns(java.util.Map<java.lang.String, java.lang.String>)
  - clearDnsEntries
```
public GraphqlApi clearDnsEntries()
```
    Removes all the entries added into Dns.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVisibility
```
public void setVisibility(String visibility)
```
    Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.
    
    Parameters:
    
    visibility - Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.
    
    See Also:
    
    GraphQLApiVisibility
  - getVisibility
```
public String getVisibility()
```
    Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.
    
    Returns:
    
    Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.
    
    See Also:
    
    GraphQLApiVisibility
  - withVisibility
```
public GraphqlApi withVisibility(String visibility)
```
    Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.
    
    Parameters:
    
    visibility - Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GraphQLApiVisibility
  - withVisibility
```
public GraphqlApi withVisibility(GraphQLApiVisibility visibility)
```
    Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.
    
    Parameters:
    
    visibility - Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GraphQLApiVisibility
  - setApiType
```
public void setApiType(String apiType)
```
    The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
    
    Parameters:
    
    apiType - The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
    
    See Also:
    
    GraphQLApiType
  - getApiType
```
public String getApiType()
```
    The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
    
    Returns:
    
    The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
    
    See Also:
    
    GraphQLApiType
  - withApiType
```
public GraphqlApi withApiType(String apiType)
```
    The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
    
    Parameters:
    
    apiType - The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GraphQLApiType
  - withApiType
```
public GraphqlApi withApiType(GraphQLApiType apiType)
```
    The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
    
    Parameters:
    
    apiType - The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GraphQLApiType
  - setMergedApiExecutionRoleArn
```
public void setMergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)
```
    The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
    
    Parameters:
    
    mergedApiExecutionRoleArn - The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
  - getMergedApiExecutionRoleArn
```
public String getMergedApiExecutionRoleArn()
```
    The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
    
    Returns:
    
    The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
  - withMergedApiExecutionRoleArn
```
public GraphqlApi withMergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)
```
    The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
    
    Parameters:
    
    mergedApiExecutionRoleArn - The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwner
```
public void setOwner(String owner)
```
    The account owner of the GraphQL API.
    
    Parameters:
    
    owner - The account owner of the GraphQL API.
  - getOwner
```
public String getOwner()
```
    The account owner of the GraphQL API.
    
    Returns:
    
    The account owner of the GraphQL API.
  - withOwner
```
public GraphqlApi withOwner(String owner)
```
    The account owner of the GraphQL API.
    
    Parameters:
    
    owner - The account owner of the GraphQL API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwnerContact
```
public void setOwnerContact(String ownerContact)
```
    The owner contact information for an API resource.
    
    This field accepts any string input with a length of 0 - 256 characters.
    
    Parameters:
    
    ownerContact - The owner contact information for an API resource.
    
    This field accepts any string input with a length of 0 - 256 characters.
  - getOwnerContact
```
public String getOwnerContact()
```
    The owner contact information for an API resource.
    
    This field accepts any string input with a length of 0 - 256 characters.
    
    Returns:
    
    The owner contact information for an API resource.
    
    This field accepts any string input with a length of 0 - 256 characters.
  - withOwnerContact
```
public GraphqlApi withOwnerContact(String ownerContact)
```
    The owner contact information for an API resource.
    
    This field accepts any string input with a length of 0 - 256 characters.
    
    Parameters:
    
    ownerContact - The owner contact information for an API resource.
    
    This field accepts any string input with a length of 0 - 256 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIntrospectionConfig
```
public void setIntrospectionConfig(String introspectionConfig)
```
    Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
    
    For more information about introspection, see GraphQL introspection.
    
    Parameters:
    
    introspectionConfig - Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
    
    For more information about introspection, see GraphQL introspection.
    
    See Also:
    
    GraphQLApiIntrospectionConfig
  - getIntrospectionConfig
```
public String getIntrospectionConfig()
```
    Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
    
    For more information about introspection, see GraphQL introspection.
    
    Returns:
    
    Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
    
    For more information about introspection, see GraphQL introspection.
    
    See Also:
    
    GraphQLApiIntrospectionConfig
  - withIntrospectionConfig
```
public GraphqlApi withIntrospectionConfig(String introspectionConfig)
```
    Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
    
    For more information about introspection, see GraphQL introspection.
    
    Parameters:
    
    introspectionConfig - Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
    
    For more information about introspection, see GraphQL introspection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GraphQLApiIntrospectionConfig
  - withIntrospectionConfig
```
public GraphqlApi withIntrospectionConfig(GraphQLApiIntrospectionConfig introspectionConfig)
```
    Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
    
    For more information about introspection, see GraphQL introspection.
    
    Parameters:
    
    introspectionConfig - Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
    
    For more information about introspection, see GraphQL introspection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GraphQLApiIntrospectionConfig
  - setQueryDepthLimit
```
public void setQueryDepthLimit(Integer queryDepthLimit)
```
    The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.
    
    Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.
    
    Parameters:
    
    queryDepthLimit - The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.
    
    Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.
  - getQueryDepthLimit
```
public Integer getQueryDepthLimit()
```
    The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.
    
    Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.
    
    Returns:
    
    The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.
    
    Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.
  - withQueryDepthLimit
```
public GraphqlApi withQueryDepthLimit(Integer queryDepthLimit)
```
    The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.
    
    Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.
    
    Parameters:
    
    queryDepthLimit - The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.
    
    Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResolverCountLimit
```
public void setResolverCountLimit(Integer resolverCountLimit)
```
    The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.
    
    Parameters:
    
    resolverCountLimit - The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.
  - getResolverCountLimit
```
public Integer getResolverCountLimit()
```
    The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.
    
    Returns:
    
    The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.
  - withResolverCountLimit
```
public GraphqlApi withResolverCountLimit(Integer resolverCountLimit)
```
    The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.
    
    Parameters:
    
    resolverCountLimit - The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnhancedMetricsConfig
```
public void setEnhancedMetricsConfig(EnhancedMetricsConfig enhancedMetricsConfig)
```
    The enhancedMetricsConfig object.
    
    Parameters:
    
    enhancedMetricsConfig - The enhancedMetricsConfig object.
  - getEnhancedMetricsConfig
```
public EnhancedMetricsConfig getEnhancedMetricsConfig()
```
    The enhancedMetricsConfig object.
    
    Returns:
    
    The enhancedMetricsConfig object.
  - withEnhancedMetricsConfig
```
public GraphqlApi withEnhancedMetricsConfig(EnhancedMetricsConfig enhancedMetricsConfig)
```
    The enhancedMetricsConfig object.
    
    Parameters:
    
    enhancedMetricsConfig - The enhancedMetricsConfig object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GraphqlApi clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class GraphqlApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GraphqlApi

Method Detail

setName

getName

withName

setApiId

getApiId

withApiId

setAuthenticationType

getAuthenticationType

withAuthenticationType

withAuthenticationType

setLogConfig

getLogConfig

withLogConfig

setUserPoolConfig

getUserPoolConfig

withUserPoolConfig

setOpenIDConnectConfig

getOpenIDConnectConfig

withOpenIDConnectConfig

setArn

getArn

withArn

getUris

setUris

withUris

addUrisEntry

clearUrisEntries

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

getAdditionalAuthenticationProviders

setAdditionalAuthenticationProviders

withAdditionalAuthenticationProviders

withAdditionalAuthenticationProviders

setXrayEnabled

getXrayEnabled

withXrayEnabled

isXrayEnabled

setWafWebAclArn

getWafWebAclArn

withWafWebAclArn

setLambdaAuthorizerConfig

getLambdaAuthorizerConfig

withLambdaAuthorizerConfig

getDns

setDns

withDns

addDnsEntry

clearDnsEntries

setVisibility

getVisibility

withVisibility

withVisibility

setApiType

getApiType

withApiType

withApiType

setMergedApiExecutionRoleArn

getMergedApiExecutionRoleArn

withMergedApiExecutionRoleArn

setOwner

getOwner

withOwner

setOwnerContact

getOwnerContact

withOwnerContact

setIntrospectionConfig

getIntrospectionConfig

withIntrospectionConfig

withIntrospectionConfig