Class CreateGraphqlApiRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateGraphqlApiRequest.Builder,
CreateGraphqlApiRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA list of additional authentication providers for theGraphqlApi
API.final GraphQLApiType
apiType()
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
).final String
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
).final AuthenticationType
The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.final String
The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.builder()
final EnhancedMetricsConfig
TheenhancedMetricsConfig
object.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AdditionalAuthenticationProviders property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Sets the value of the GraphQL API to enable (ENABLED
) or disable (DISABLED
) introspection.final String
Sets the value of the GraphQL API to enable (ENABLED
) or disable (DISABLED
) introspection.final LambdaAuthorizerConfig
Configuration for Lambda function authorization.final LogConfig
The Amazon CloudWatch Logs configuration.final String
The Identity and Access Management service role ARN for a merged API.final String
name()
A user-supplied name for theGraphqlApi
.final OpenIDConnectConfig
The OIDC configuration.final String
The owner contact information for an API resource.final Integer
The maximum depth a query can have in a single request.final Integer
The maximum number of resolvers that can be invoked in a single request.static Class
<? extends CreateGraphqlApiRequest.Builder> tags()
ATagMap
object.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final UserPoolConfig
The Amazon Cognito user pool configuration.final GraphQLApiVisibility
Sets the value of the GraphQL API to public (GLOBAL
) or private (PRIVATE
).final String
Sets the value of the GraphQL API to public (GLOBAL
) or private (PRIVATE
).final Boolean
A flag indicating whether to use X-Ray tracing for theGraphqlApi
.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
A user-supplied name for the
GraphqlApi
.- Returns:
- A user-supplied name for the
GraphqlApi
.
-
logConfig
The Amazon CloudWatch Logs configuration.
- Returns:
- The Amazon CloudWatch Logs configuration.
-
authenticationType
The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- Returns:
- The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
- See Also:
-
authenticationTypeAsString
The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- Returns:
- The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
- See Also:
-
userPoolConfig
The Amazon Cognito user pool configuration.
- Returns:
- The Amazon Cognito user pool configuration.
-
openIDConnectConfig
The OIDC configuration.
- Returns:
- The OIDC configuration.
-
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 theisEmpty()
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
A
TagMap
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:
- A
TagMap
object.
-
hasAdditionalAuthenticationProviders
public final boolean hasAdditionalAuthenticationProviders()For responses, this returns true if the service returned a value for the AdditionalAuthenticationProviders property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.
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
hasAdditionalAuthenticationProviders()
method.- Returns:
- A list of additional authentication providers for the
GraphqlApi
API.
-
xrayEnabled
A flag indicating whether to use X-Ray tracing for the
GraphqlApi
.- Returns:
- A flag indicating whether to use X-Ray tracing for the
GraphqlApi
.
-
lambdaAuthorizerConfig
Configuration for Lambda function authorization.
- Returns:
- Configuration for Lambda function authorization.
-
visibility
Sets the value of the GraphQL API to public (
GLOBAL
) or private (PRIVATE
). If no value is provided, the visibility will be set toGLOBAL
by default. This value cannot be changed once the API has been created.If the service returns an enum value that is not available in the current SDK version,
visibility
will returnGraphQLApiVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvisibilityAsString()
.- Returns:
- Sets the value of the GraphQL API to public (
GLOBAL
) or private (PRIVATE
). If no value is provided, the visibility will be set toGLOBAL
by default. This value cannot be changed once the API has been created. - See Also:
-
visibilityAsString
Sets the value of the GraphQL API to public (
GLOBAL
) or private (PRIVATE
). If no value is provided, the visibility will be set toGLOBAL
by default. This value cannot be changed once the API has been created.If the service returns an enum value that is not available in the current SDK version,
visibility
will returnGraphQLApiVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvisibilityAsString()
.- Returns:
- Sets the value of the GraphQL API to public (
GLOBAL
) or private (PRIVATE
). If no value is provided, the visibility will be set toGLOBAL
by default. This value cannot be changed once the API has been created. - See Also:
-
apiType
The value that indicates whether the GraphQL API is a standard API (
GRAPHQL
) or merged API (MERGED
).If the service returns an enum value that is not available in the current SDK version,
apiType
will returnGraphQLApiType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapiTypeAsString()
.- Returns:
- The value that indicates whether the GraphQL API is a standard API (
GRAPHQL
) or merged API (MERGED
). - See Also:
-
apiTypeAsString
The value that indicates whether the GraphQL API is a standard API (
GRAPHQL
) or merged API (MERGED
).If the service returns an enum value that is not available in the current SDK version,
apiType
will returnGraphQLApiType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapiTypeAsString()
.- Returns:
- The value that indicates whether the GraphQL API is a standard API (
GRAPHQL
) or merged API (MERGED
). - See Also:
-
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:
- 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.
-
ownerContact
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.
-
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 toENABLED
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.
If the service returns an enum value that is not available in the current SDK version,
introspectionConfig
will returnGraphQLApiIntrospectionConfig.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromintrospectionConfigAsString()
.- 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 toENABLED
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:
-
introspectionConfigAsString
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 toENABLED
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.
If the service returns an enum value that is not available in the current SDK version,
introspectionConfig
will returnGraphQLApiIntrospectionConfig.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromintrospectionConfigAsString()
.- 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 toENABLED
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:
-
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 between1
and75
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 between1
and75
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.
-
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 to10000
. When specified, the limit value can be between1
and10000
. 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 to10000
. When specified, the limit value can be between1
and10000
. This field will produce a limit error if the operation falls out of bounds.
-
enhancedMetricsConfig
The
enhancedMetricsConfig
object.- Returns:
- The
enhancedMetricsConfig
object.
-
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 interfaceToCopyableBuilder<CreateGraphqlApiRequest.Builder,
CreateGraphqlApiRequest> - Specified by:
toBuilder
in classAppSyncRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-