Package software.amazon.awssdk.services.apigateway.model

Class Stage

    • Method Detail

      • deploymentId

        public final String deploymentId()

        The identifier of the Deployment that the stage points to.

        Returns:
        The identifier of the Deployment that the stage points to.

      • clientCertificateId

        public final String clientCertificateId()

        The identifier of a client certificate for an API stage.

        Returns:
        The identifier of a client certificate for an API stage.

      • stageName

        public final String stageName()

        The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

        Returns:
        The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

      • description

        public final String description()

        The stage's description.

        Returns:
        The stage's description.

      • cacheClusterEnabled

        public final Boolean cacheClusterEnabled()

        Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.

        Returns:
        Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.

      • cacheClusterStatusAsString

        public final String cacheClusterStatusAsString()

        The status of the cache cluster for the stage, if enabled.

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

        Returns:
        The status of the cache cluster for the stage, if enabled.
        See Also:
        CacheClusterStatus

      • hasMethodSettings

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

      • methodSettings

        public final Map<String,​MethodSetting> methodSettings()

        A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

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

        Returns:
        A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

      • hasVariables

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

      • variables

        public final Map<String,​String> variables()

        A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

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

        Returns:
        A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

      • documentationVersion

        public final String documentationVersion()

        The version of the associated API documentation.

        Returns:
        The version of the associated API documentation.

      • accessLogSettings

        public final AccessLogSettings accessLogSettings()

        Settings for logging access in this stage.

        Returns:
        Settings for logging access in this stage.

      • canarySettings

        public final CanarySettings canarySettings()

        Settings for the canary deployment in this stage.

        Returns:
        Settings for the canary deployment in this stage.

      • tracingEnabled

        public final Boolean tracingEnabled()

        Specifies whether active tracing with X-ray is enabled for the Stage.

        Returns:
        Specifies whether active tracing with X-ray is enabled for the Stage.

      • webAclArn

        public final String webAclArn()

        The ARN of the WebAcl associated with the Stage.

        Returns:
        The ARN of the WebAcl associated with the Stage.

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

        The collection of tags. Each tag element is associated with a given resource.

        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:
        The collection of tags. Each tag element is associated with a given resource.

      • createdDate

        public final Instant createdDate()

        The timestamp when the stage was created.

        Returns:
        The timestamp when the stage was created.

      • lastUpdatedDate

        public final Instant lastUpdatedDate()

        The timestamp when the stage last updated.

        Returns:
        The timestamp when the stage last updated.

      • serializableBuilderClass

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

      • hashCode

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

      • equals

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

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