Class Deployment

java.lang.Object
software.amazon.awssdk.services.apigatewayv2.model.Deployment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Deployment.Builder,Deployment>
@Generated("software.amazon.awssdk:codegen") public final class Deployment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Deployment.Builder,Deployment>

An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.

See Also:

  • Method Details

    • autoDeployed

      public final Boolean autoDeployed()

      Specifies whether a deployment was automatically released.

      Returns:
      Specifies whether a deployment was automatically released.

    • createdDate

      public final Instant createdDate()

      The date and time when the Deployment resource was created.

      Returns:
      The date and time when the Deployment resource was created.

    • deploymentId

      public final String deploymentId()

      The identifier for the deployment.

      Returns:
      The identifier for the deployment.

    • deploymentStatus

      public final DeploymentStatus deploymentStatus()

      The status of the deployment: PENDING, FAILED, or SUCCEEDED.

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

      Returns:
      The status of the deployment: PENDING, FAILED, or SUCCEEDED.
      See Also:

    • deploymentStatusAsString

      public final String deploymentStatusAsString()

      The status of the deployment: PENDING, FAILED, or SUCCEEDED.

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

      Returns:
      The status of the deployment: PENDING, FAILED, or SUCCEEDED.
      See Also:

    • deploymentStatusMessage

      public final String deploymentStatusMessage()

      May contain additional feedback on the status of an API deployment.

      Returns:
      May contain additional feedback on the status of an API deployment.

    • description

      public final String description()

      The description for the deployment.

      Returns:
      The description for the deployment.

    • toBuilder

      public Deployment.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<Deployment.Builder,Deployment>
      Returns:
      a builder for type T

    • builder

      public static Deployment.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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