com.amazonaws.services.apigatewayv2.model

Class UpdateStageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigatewayv2.model.UpdateStageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateStageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Updates a Stage.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateStageRequest()

Method Summary

Modifier and Type	Method and Description
UpdateStageRequest	addRouteSettingsEntry(String key, RouteSettings value) Add a single RouteSettings entry
UpdateStageRequest	addStageVariablesEntry(String key, String value) Add a single StageVariables entry
UpdateStageRequest	clearRouteSettingsEntries() Removes all the entries added into RouteSettings.
UpdateStageRequest	clearStageVariablesEntries() Removes all the entries added into StageVariables.
UpdateStageRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AccessLogSettings	getAccessLogSettings() Settings for logging access in this stage.
String	getApiId() The API identifier.
Boolean	getAutoDeploy() Specifies whether updates to an API automatically trigger a new deployment.
String	getClientCertificateId() The identifier of a client certificate for a Stage.
RouteSettings	getDefaultRouteSettings() The default route settings for the stage.
String	getDeploymentId() The deployment identifier for the API stage.
String	getDescription() The description for the API stage.
Map<String,RouteSettings>	getRouteSettings() Route settings for the stage.
String	getStageName() The stage name.
Map<String,String>	getStageVariables() A map that defines the stage variables for a Stage.
int	hashCode()
Boolean	isAutoDeploy() Specifies whether updates to an API automatically trigger a new deployment.
void	setAccessLogSettings(AccessLogSettings accessLogSettings) Settings for logging access in this stage.
void	setApiId(String apiId) The API identifier.
void	setAutoDeploy(Boolean autoDeploy) Specifies whether updates to an API automatically trigger a new deployment.
void	setClientCertificateId(String clientCertificateId) The identifier of a client certificate for a Stage.
void	setDefaultRouteSettings(RouteSettings defaultRouteSettings) The default route settings for the stage.
void	setDeploymentId(String deploymentId) The deployment identifier for the API stage.
void	setDescription(String description) The description for the API stage.
void	setRouteSettings(Map<String,RouteSettings> routeSettings) Route settings for the stage.
void	setStageName(String stageName) The stage name.
void	setStageVariables(Map<String,String> stageVariables) A map that defines the stage variables for a Stage.
String	toString() Returns a string representation of this object.
UpdateStageRequest	withAccessLogSettings(AccessLogSettings accessLogSettings) Settings for logging access in this stage.
UpdateStageRequest	withApiId(String apiId) The API identifier.
UpdateStageRequest	withAutoDeploy(Boolean autoDeploy) Specifies whether updates to an API automatically trigger a new deployment.
UpdateStageRequest	withClientCertificateId(String clientCertificateId) The identifier of a client certificate for a Stage.
UpdateStageRequest	withDefaultRouteSettings(RouteSettings defaultRouteSettings) The default route settings for the stage.
UpdateStageRequest	withDeploymentId(String deploymentId) The deployment identifier for the API stage.
UpdateStageRequest	withDescription(String description) The description for the API stage.
UpdateStageRequest	withRouteSettings(Map<String,RouteSettings> routeSettings) Route settings for the stage.
UpdateStageRequest	withStageName(String stageName) The stage name.
UpdateStageRequest	withStageVariables(Map<String,String> stageVariables) A map that defines the stage variables for a Stage.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateStageRequest

public UpdateStageRequest()

Method Detail

setAccessLogSettings

public void setAccessLogSettings(AccessLogSettings accessLogSettings)

Settings for logging access in this stage.

Parameters:

accessLogSettings - Settings for logging access in this stage.

getAccessLogSettings

public AccessLogSettings getAccessLogSettings()

Settings for logging access in this stage.

Returns:

Settings for logging access in this stage.

withAccessLogSettings

public UpdateStageRequest withAccessLogSettings(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.

setApiId

public void setApiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

getApiId

public String getApiId()

The API identifier.

Returns:

The API identifier.

withApiId

public UpdateStageRequest withApiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAutoDeploy

public void setAutoDeploy(Boolean autoDeploy)

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Parameters:

autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

getAutoDeploy

public Boolean getAutoDeploy()

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Returns:

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

withAutoDeploy

public UpdateStageRequest withAutoDeploy(Boolean autoDeploy)

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Parameters:

autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Returns:

Returns a reference to this object so that method calls can be chained together.

isAutoDeploy

public Boolean isAutoDeploy()

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Returns:

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

setClientCertificateId

public void setClientCertificateId(String clientCertificateId)

The identifier of a client certificate for a Stage.

Parameters:

clientCertificateId - The identifier of a client certificate for a Stage.

getClientCertificateId

public String getClientCertificateId()

The identifier of a client certificate for a Stage.

Returns:

The identifier of a client certificate for a Stage.

withClientCertificateId

public UpdateStageRequest withClientCertificateId(String clientCertificateId)

The identifier of a client certificate for a Stage.

Parameters:

clientCertificateId - The identifier of a client certificate for a Stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDefaultRouteSettings

public void setDefaultRouteSettings(RouteSettings defaultRouteSettings)

The default route settings for the stage.

Parameters:

defaultRouteSettings - The default route settings for the stage.

getDefaultRouteSettings

public RouteSettings getDefaultRouteSettings()

The default route settings for the stage.

Returns:

The default route settings for the stage.

withDefaultRouteSettings

public UpdateStageRequest withDefaultRouteSettings(RouteSettings defaultRouteSettings)

The default route settings for the stage.

Parameters:

defaultRouteSettings - The default route settings for the stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeploymentId

public void setDeploymentId(String deploymentId)

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

Parameters:

deploymentId - The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

getDeploymentId

public String getDeploymentId()

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

Returns:

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

withDeploymentId

public UpdateStageRequest withDeploymentId(String deploymentId)

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

Parameters:

deploymentId - The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The description for the API stage.

Parameters:

description - The description for the API stage.

getDescription

public String getDescription()

The description for the API stage.

Returns:

The description for the API stage.

withDescription

public UpdateStageRequest withDescription(String description)

The description for the API stage.

Parameters:

description - The description for the API stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

getRouteSettings

public Map<String,RouteSettings> getRouteSettings()

Route settings for the stage.

Returns:

Route settings for the stage.

setRouteSettings

public void setRouteSettings(Map<String,RouteSettings> routeSettings)

Route settings for the stage.

Parameters:

routeSettings - Route settings for the stage.

withRouteSettings

public UpdateStageRequest withRouteSettings(Map<String,RouteSettings> routeSettings)

Route settings for the stage.

Parameters:

routeSettings - Route settings for the stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

addRouteSettingsEntry

public UpdateStageRequest addRouteSettingsEntry(String key,
                                                RouteSettings value)

Add a single RouteSettings entry

See Also:

withRouteSettings(java.util.Map<java.lang.String, com.amazonaws.services.apigatewayv2.model.RouteSettings>)

clearRouteSettingsEntries

public UpdateStageRequest clearRouteSettingsEntries()

Removes all the entries added into RouteSettings.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStageName

public void setStageName(String stageName)

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

Parameters:

stageName - The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

getStageName

public String getStageName()

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

Returns:

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

withStageName

public UpdateStageRequest withStageName(String stageName)

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

Parameters:

stageName - The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

getStageVariables

public Map<String,String> getStageVariables()

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

Returns:

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

setStageVariables

public void setStageVariables(Map<String,String> stageVariables)

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

Parameters:

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

withStageVariables

public UpdateStageRequest withStageVariables(Map<String,String> stageVariables)

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

Parameters:

stageVariables - A map that defines the stage variables for a Stage. 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.

addStageVariablesEntry

public UpdateStageRequest addStageVariablesEntry(String key,
                                                 String value)

Add a single StageVariables entry

See Also:

withStageVariables(java.util.Map<java.lang.String, java.lang.String>)

clearStageVariablesEntries

public UpdateStageRequest clearStageVariablesEntries()

Removes all the entries added into StageVariables.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateStageRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()