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

Interface Stage.Builder

    • Method Detail

      • deploymentId

        Stage.Builder deploymentId​(String deploymentId)

        The identifier of the Deployment that the stage points to.

        Parameters:
        deploymentId - The identifier of the Deployment that the stage points to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientCertificateId

        Stage.Builder clientCertificateId​(String clientCertificateId)

        The identifier of a client certificate for an API stage.

        Parameters:
        clientCertificateId - The identifier of a client certificate for an API stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stageName

        Stage.Builder stageName​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • description

        Stage.Builder description​(String description)

        The stage's description.

        Parameters:
        description - The stage's description.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cacheClusterEnabled

        Stage.Builder cacheClusterEnabled​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • cacheClusterStatus

        Stage.Builder cacheClusterStatus​(String cacheClusterStatus)

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

        Parameters:
        cacheClusterStatus - The status of the cache cluster for the stage, if enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CacheClusterStatus, CacheClusterStatus

      • cacheClusterStatus

        Stage.Builder cacheClusterStatus​(CacheClusterStatus cacheClusterStatus)

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

        Parameters:
        cacheClusterStatus - The status of the cache cluster for the stage, if enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CacheClusterStatus, CacheClusterStatus

      • methodSettings

        Stage.Builder methodSettings​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • variables

        Stage.Builder variables​(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-._~:/?#&=,]+.

        Parameters:
        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-._~:/?#&=,]+.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentationVersion

        Stage.Builder documentationVersion​(String documentationVersion)

        The version of the associated API documentation.

        Parameters:
        documentationVersion - The version of the associated API documentation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accessLogSettings

        Stage.Builder accessLogSettings​(AccessLogSettings accessLogSettings)

        Settings for logging access in this stage.

        Parameters:
        accessLogSettings - Settings for logging access in this stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • canarySettings

        Stage.Builder canarySettings​(CanarySettings canarySettings)

        Settings for the canary deployment in this stage.

        Parameters:
        canarySettings - Settings for the canary deployment in this stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tracingEnabled

        Stage.Builder tracingEnabled​(Boolean tracingEnabled)

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

        Parameters:
        tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • webAclArn

        Stage.Builder webAclArn​(String webAclArn)

        The ARN of the WebAcl associated with the Stage.

        Parameters:
        webAclArn - The ARN of the WebAcl associated with the Stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        Stage.Builder tags​(Map<String,​String> tags)

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

        Parameters:
        tags - The collection of tags. Each tag element is associated with a given resource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdDate

        Stage.Builder createdDate​(Instant createdDate)

        The timestamp when the stage was created.

        Parameters:
        createdDate - The timestamp when the stage was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastUpdatedDate

        Stage.Builder lastUpdatedDate​(Instant lastUpdatedDate)

        The timestamp when the stage last updated.

        Parameters:
        lastUpdatedDate - The timestamp when the stage last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.