ws.osiris.aws

Class Stage

ws.osiris.aws.Stage

public class Stage

Represents a single stage in API Gateway.

A stage represents a deployed snapshot of an API. An API must be deployed to a stage before it can be used.

Is is common to have multiple stages representing different points in the application lifecycle. For example, an application might be deployed to the dev stage whenever any code changes are made. It might be deployed to the test stages for testing before release. And finally it might be deployed to the prod stage one it is fully tested and ready for release.

See here for more information about stages.

See Also:

here

Constructor Summary

Constructors

Constructor and Description
Stage(java.lang.String name, boolean deployOnUpdate, java.util.Map<java.lang.String,java.lang.String> variables, java.lang.String description) Represents a single stage in API Gateway.

Method Summary

Modifier and Type	Method and Description
java.lang.String	component1() The name of the stage.
boolean	component2() Flag controlling whether the API is deployed to the stage every time it is updated.
java.util.Map<java.lang.String,java.lang.String>	component3() The stage variables;
java.lang.String	component4() A description of the stage.
Stage	copy(java.lang.String name, boolean deployOnUpdate, java.util.Map<java.lang.String,java.lang.String> variables, java.lang.String description) Represents a single stage in API Gateway.
boolean	equals(java.lang.Object p)
boolean	getDeployOnUpdate() Flag controlling whether the API is deployed to the stage every time it is updated.
java.lang.String	getDescription() A description of the stage.
java.lang.String	getName() The name of the stage.
java.util.Map<java.lang.String,java.lang.String>	getVariables() The stage variables;
int	hashCode()
java.lang.String	toString()

Constructor Detail

Stage

public Stage(@NotNull
             java.lang.String name,
             boolean deployOnUpdate,
             @NotNull
             java.util.Map<java.lang.String,java.lang.String> variables,
             @NotNull
             java.lang.String description)

Represents a single stage in API Gateway.

A stage represents a deployed snapshot of an API. An API must be deployed to a stage before it can be used.

Is is common to have multiple stages representing different points in the application lifecycle. For example, an application might be deployed to the dev stage whenever any code changes are made. It might be deployed to the test stages for testing before release. And finally it might be deployed to the prod stage one it is fully tested and ready for release.

See here for more information about stages.

Parameters:

name - The name of the stage.

deployOnUpdate -

Flag controlling whether the API is deployed to the stage every time it is updated.

If this is true, the API is deployed to the stage whenever mvn deploy is executed. If this is false, the API is only deployed to the stage when it is created. Subsequent updates are not deployed automatically and the API is only deployed to the stage by some manual process.

This is likely to be true for development stages and false for production stages.

variables - The stage variables; these are environment variables that can have different values in each stage.

description - A description of the stage.

See Also:

here

Method Detail

getName

@NotNull
public java.lang.String getName()

The name of the stage.

getDeployOnUpdate

public boolean getDeployOnUpdate()

Flag controlling whether the API is deployed to the stage every time it is updated.

If this is true, the API is deployed to the stage whenever mvn deploy is executed. If this is false, the API is only deployed to the stage when it is created. Subsequent updates are not deployed automatically and the API is only deployed to the stage by some manual process.

This is likely to be true for development stages and false for production stages.

getVariables

@NotNull
public java.util.Map<java.lang.String,java.lang.String> getVariables()

The stage variables;

these are environment variables that can have different values in each stage.

getDescription

@NotNull
public java.lang.String getDescription()

A description of the stage.

component1

@NotNull
public java.lang.String component1()

The name of the stage.

component2

public boolean component2()

Flag controlling whether the API is deployed to the stage every time it is updated.

If this is true, the API is deployed to the stage whenever mvn deploy is executed. If this is false, the API is only deployed to the stage when it is created. Subsequent updates are not deployed automatically and the API is only deployed to the stage by some manual process.

This is likely to be true for development stages and false for production stages.

component3

@NotNull
public java.util.Map<java.lang.String,java.lang.String> component3()

The stage variables;

these are environment variables that can have different values in each stage.

component4

@NotNull
public java.lang.String component4()

A description of the stage.

copy

@NotNull
public Stage copy(@NotNull
                           java.lang.String name,
                           boolean deployOnUpdate,
                           @NotNull
                           java.util.Map<java.lang.String,java.lang.String> variables,
                           @NotNull
                           java.lang.String description)

Represents a single stage in API Gateway.

A stage represents a deployed snapshot of an API. An API must be deployed to a stage before it can be used.

Is is common to have multiple stages representing different points in the application lifecycle. For example, an application might be deployed to the dev stage whenever any code changes are made. It might be deployed to the test stages for testing before release. And finally it might be deployed to the prod stage one it is fully tested and ready for release.

See here for more information about stages.

See Also:

here

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)