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`	`addTagsEntry(String key, String value)` Add a single Tags entry
`GraphqlApi`	`addUrisEntry(String key, String value)` Add a single Uris entry
`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`	`getArn()` The Amazon Resource Name (ARN).
`String`	`getAuthenticationType()` The authentication type.
`LambdaAuthorizerConfig`	`getLambdaAuthorizerConfig()` Configuration for Lambda function authorization.
`LogConfig`	`getLogConfig()` The Amazon CloudWatch Logs configuration.
`String`	`getName()` The API name.
`OpenIDConnectConfig`	`getOpenIDConnectConfig()` The OpenID Connect configuration.
`Map<String,String>`	`getTags()` The tags.
`Map<String,String>`	`getUris()` The URIs.
`UserPoolConfig`	`getUserPoolConfig()` The Amazon Cognito user pool configuration.
`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`	`setArn(String arn)` The Amazon Resource Name (ARN).
`void`	`setAuthenticationType(String authenticationType)` The authentication type.
`void`	`setLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)` Configuration for Lambda function authorization.
`void`	`setLogConfig(LogConfig logConfig)` The Amazon CloudWatch Logs configuration.
`void`	`setName(String name)` The API name.
`void`	`setOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)` The OpenID Connect configuration.
`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`	`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`	`withArn(String arn)` The Amazon Resource Name (ARN).
`GraphqlApi`	`withAuthenticationType(AuthenticationType authenticationType)` The authentication type.
`GraphqlApi`	`withAuthenticationType(String authenticationType)` The authentication type.
`GraphqlApi`	`withLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)` Configuration for Lambda function authorization.
`GraphqlApi`	`withLogConfig(LogConfig logConfig)` The Amazon CloudWatch Logs configuration.
`GraphqlApi`	`withName(String name)` The API name.
`GraphqlApi`	`withOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)` The OpenID Connect configuration.
`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`	`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.
  - 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.

Did this page help you?

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

toString

equals

hashCode

clone

marshall