software.amazon.awssdk.services.appsync.model

Class CreateGraphqlApiRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appsync.model.AppSyncRequest

software.amazon.awssdk.services.appsync.model.CreateGraphqlApiRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateGraphqlApiRequest.Builder,CreateGraphqlApiRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateGraphqlApiRequest
extends AppSyncRequest
implements ToCopyableBuilder<CreateGraphqlApiRequest.Builder,CreateGraphqlApiRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateGraphqlApiRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<AdditionalAuthenticationProvider>	additionalAuthenticationProviders() A list of additional authentication providers for the GraphqlApi API.
GraphQLApiType	apiType() The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
String	apiTypeAsString() The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
AuthenticationType	authenticationType() The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
String	authenticationTypeAsString() The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
static CreateGraphqlApiRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalAuthenticationProviders() For responses, this returns true if the service returned a value for the AdditionalAuthenticationProviders property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
LambdaAuthorizerConfig	lambdaAuthorizerConfig() Configuration for Lambda function authorization.
LogConfig	logConfig() The Amazon CloudWatch Logs configuration.
String	mergedApiExecutionRoleArn() The Identity and Access Management service role ARN for a merged API.
String	name() A user-supplied name for the GraphqlApi.
OpenIDConnectConfig	openIDConnectConfig() The OIDC configuration.
String	ownerContact() The owner contact information for an API resource.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateGraphqlApiRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() A TagMap object.
CreateGraphqlApiRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
UserPoolConfig	userPoolConfig() The Amazon Cognito user pool configuration.
GraphQLApiVisibility	visibility() Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE).
String	visibilityAsString() Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE).
Boolean	xrayEnabled() A flag indicating whether to use X-Ray tracing for the GraphqlApi.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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()

A user-supplied name for the GraphqlApi.

Returns:

A user-supplied name for the GraphqlApi.

logConfig

public final LogConfig logConfig()

The Amazon CloudWatch Logs configuration.

Returns:

The Amazon CloudWatch Logs configuration.

authenticationType

public final AuthenticationType 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 return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

Returns:

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

See Also:

AuthenticationType

authenticationTypeAsString

public final String 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 return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

Returns:

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

See Also:

AuthenticationType

userPoolConfig

public final UserPoolConfig userPoolConfig()

The Amazon Cognito user pool configuration.

Returns:

The Amazon Cognito user pool configuration.

openIDConnectConfig

public final OpenIDConnectConfig 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 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()

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 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.

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.

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

public final Boolean 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

public final LambdaAuthorizerConfig lambdaAuthorizerConfig()

Configuration for Lambda function authorization.

Returns:

Configuration for Lambda function authorization.

visibility

public final 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.

If the service returns an enum value that is not available in the current SDK version, visibility will return GraphQLApiVisibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

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

visibilityAsString

public final String visibilityAsString()

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.

If the service returns an enum value that is not available in the current SDK version, visibility will return GraphQLApiVisibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

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

apiType

public final GraphQLApiType 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 return GraphQLApiType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiTypeAsString().

Returns:

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

See Also:

GraphQLApiType

apiTypeAsString

public final String 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 return GraphQLApiType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiTypeAsString().

Returns:

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

See Also:

GraphQLApiType

mergedApiExecutionRoleArn

public final 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.

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

public final String 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.

toBuilder

public CreateGraphqlApiRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateGraphqlApiRequest.Builder,CreateGraphqlApiRequest>

Specified by:

toBuilder in class AppSyncRequest

builder

public static CreateGraphqlApiRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateGraphqlApiRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo