Class CreateApiResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response
software.amazon.awssdk.services.apigatewayv2.model.CreateApiResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateApiResponse.Builder,CreateApiResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateApiResponse extends ApiGatewayV2Response implements ToCopyableBuilder<CreateApiResponse.Builder,CreateApiResponse>

  • Method Details

    • apiEndpoint

      public final String apiEndpoint()

      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

      Returns:
      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

    • apiGatewayManaged

      public final Boolean apiGatewayManaged()

      Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

      Returns:
      Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

    • apiId

      public final String apiId()

      The API ID.

      Returns:
      The API ID.

    • apiKeySelectionExpression

      public final String apiKeySelectionExpression()

      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

      Returns:
      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

    • corsConfiguration

      public final Cors corsConfiguration()

      A CORS configuration. Supported only for HTTP APIs.

      Returns:
      A CORS configuration. Supported only for HTTP APIs.

    • createdDate

      public final Instant createdDate()

      The timestamp when the API was created.

      Returns:
      The timestamp when the API was created.

    • description

      public final String description()

      The description of the API.

      Returns:
      The description of the API.

    • disableSchemaValidation

      public final Boolean disableSchemaValidation()

      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

      Returns:
      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

    • disableExecuteApiEndpoint

      public final Boolean disableExecuteApiEndpoint()

      Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

      Returns:
      Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

    • hasImportInfo

      public final boolean hasImportInfo()
      For responses, this returns true if the service returned a value for the ImportInfo 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.

    • importInfo

      public final List<String> importInfo()

      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

      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 hasImportInfo() method.

      Returns:
      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

    • ipAddressType

      public final IpAddressType ipAddressType()

      The IP address types that can invoke the API.

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

      Returns:
      The IP address types that can invoke the API.
      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      The IP address types that can invoke the API.

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

      Returns:
      The IP address types that can invoke the API.
      See Also:

    • name

      public final String name()

      The name of the API.

      Returns:
      The name of the API.

    • protocolType

      public final ProtocolType protocolType()

      The API protocol.

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

      Returns:
      The API protocol.
      See Also:

    • protocolTypeAsString

      public final String protocolTypeAsString()

      The API protocol.

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

      Returns:
      The API protocol.
      See Also:

    • routeSelectionExpression

      public final String routeSelectionExpression()

      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

      Returns:
      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

    • 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 collection of tags associated with the 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 hasTags() method.

      Returns:
      A collection of tags associated with the API.

    • version

      public final String version()

      A version identifier for the API.

      Returns:
      A version identifier for the API.

    • hasWarnings

      public final boolean hasWarnings()
      For responses, this returns true if the service returned a value for the Warnings 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.

    • warnings

      public final List<String> warnings()

      The warning messages reported when failonwarnings is turned on during API import.

      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 hasWarnings() method.

      Returns:
      The warning messages reported when failonwarnings is turned on during API import.

    • toBuilder

      public CreateApiResponse.Builder 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 interface ToCopyableBuilder<CreateApiResponse.Builder,CreateApiResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateApiResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.