software.amazon.awssdk.services.apigatewayv2.model

Class Stage

java.lang.Object

software.amazon.awssdk.services.apigatewayv2.model.Stage

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Stage.Builder,Stage>

@Generated(value="software.amazon.awssdk:codegen")
public final class Stage
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Stage.Builder,Stage>

Represents an API stage.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Stage.Builder

Method Summary

Modifier and Type	Method and Description
AccessLogSettings	accessLogSettings() Settings for logging access in this stage.
static Stage.Builder	builder()
String	clientCertificateId() The identifier of a client certificate for a Stage.
Instant	createdDate() The timestamp when the stage was created.
RouteSettings	defaultRouteSettings() Default route settings for the stage.
String	deploymentId() The identifier of the Deployment that the Stage is associated with.
String	description() The description of the stage.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedDate() The timestamp when the stage was last updated.
Map<String,RouteSettings>	routeSettings() Route settings for the stage.
List<SdkField<?>>	sdkFields()
static Class<? extends Stage.Builder>	serializableBuilderClass()
String	stageName() The name of the stage.
Map<String,String>	stageVariables() A map that defines the stage variables for a stage resource.
Map<String,String>	tags() The key-value map of strings.
Stage.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

accessLogSettings

public AccessLogSettings accessLogSettings()

Settings for logging access in this stage.

Returns:

Settings for logging access in this stage.

clientCertificateId

public String clientCertificateId()

The identifier of a client certificate for a Stage.

Returns:

The identifier of a client certificate for a Stage.

createdDate

public Instant createdDate()

The timestamp when the stage was created.

Returns:

The timestamp when the stage was created.

defaultRouteSettings

public RouteSettings defaultRouteSettings()

Default route settings for the stage.

Returns:

Default route settings for the stage.

deploymentId

public String deploymentId()

The identifier of the Deployment that the Stage is associated with.

Returns:

The identifier of the Deployment that the Stage is associated with.

description

public String description()

The description of the stage.

Returns:

The description of the stage.

lastUpdatedDate

public Instant lastUpdatedDate()

The timestamp when the stage was last updated.

Returns:

The timestamp when the stage was last updated.

routeSettings

public Map<String,RouteSettings> routeSettings()

Route settings for the stage.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Route settings for the stage.

stageName

public String stageName()

The name of the stage.

Returns:

The name of the stage.

stageVariables

public Map<String,String> stageVariables()

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.

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

tags

public Map<String,String> tags()

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

toBuilder

public Stage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Stage.Builder,Stage>

builder

public static Stage.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo