com.amazonaws.services.mainframemodernization.model

Class UpdateEnvironmentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.mainframemodernization.model.UpdateEnvironmentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateEnvironmentRequest()

Method Summary

Modifier and Type	Method and Description
UpdateEnvironmentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getApplyDuringMaintenanceWindow() Indicates whether to update the runtime environment during the maintenance window.
Integer	getDesiredCapacity() The desired capacity for the runtime environment to update.
String	getEngineVersion() The version of the runtime engine for the runtime environment.
String	getEnvironmentId() The unique identifier of the runtime environment that you want to update.
Boolean	getForceUpdate() Forces the updates on the environment.
String	getInstanceType() The instance type for the runtime environment to update.
String	getPreferredMaintenanceWindow() Configures the maintenance window that you want for the runtime environment.
int	hashCode()
Boolean	isApplyDuringMaintenanceWindow() Indicates whether to update the runtime environment during the maintenance window.
Boolean	isForceUpdate() Forces the updates on the environment.
void	setApplyDuringMaintenanceWindow(Boolean applyDuringMaintenanceWindow) Indicates whether to update the runtime environment during the maintenance window.
void	setDesiredCapacity(Integer desiredCapacity) The desired capacity for the runtime environment to update.
void	setEngineVersion(String engineVersion) The version of the runtime engine for the runtime environment.
void	setEnvironmentId(String environmentId) The unique identifier of the runtime environment that you want to update.
void	setForceUpdate(Boolean forceUpdate) Forces the updates on the environment.
void	setInstanceType(String instanceType) The instance type for the runtime environment to update.
void	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) Configures the maintenance window that you want for the runtime environment.
String	toString() Returns a string representation of this object.
UpdateEnvironmentRequest	withApplyDuringMaintenanceWindow(Boolean applyDuringMaintenanceWindow) Indicates whether to update the runtime environment during the maintenance window.
UpdateEnvironmentRequest	withDesiredCapacity(Integer desiredCapacity) The desired capacity for the runtime environment to update.
UpdateEnvironmentRequest	withEngineVersion(String engineVersion) The version of the runtime engine for the runtime environment.
UpdateEnvironmentRequest	withEnvironmentId(String environmentId) The unique identifier of the runtime environment that you want to update.
UpdateEnvironmentRequest	withForceUpdate(Boolean forceUpdate) Forces the updates on the environment.
UpdateEnvironmentRequest	withInstanceType(String instanceType) The instance type for the runtime environment to update.
UpdateEnvironmentRequest	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) Configures the maintenance window that you want for the runtime environment.

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

UpdateEnvironmentRequest

public UpdateEnvironmentRequest()

Method Detail

setApplyDuringMaintenanceWindow

public void setApplyDuringMaintenanceWindow(Boolean applyDuringMaintenanceWindow)

Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

Parameters:

applyDuringMaintenanceWindow - Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

getApplyDuringMaintenanceWindow

public Boolean getApplyDuringMaintenanceWindow()

Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

Returns:

Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

withApplyDuringMaintenanceWindow

public UpdateEnvironmentRequest withApplyDuringMaintenanceWindow(Boolean applyDuringMaintenanceWindow)

Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

Parameters:

applyDuringMaintenanceWindow - Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

Returns:

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

isApplyDuringMaintenanceWindow

public Boolean isApplyDuringMaintenanceWindow()

Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

Returns:

Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

setDesiredCapacity

public void setDesiredCapacity(Integer desiredCapacity)

The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

Parameters:

desiredCapacity - The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

getDesiredCapacity

public Integer getDesiredCapacity()

The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

Returns:

The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

withDesiredCapacity

public UpdateEnvironmentRequest withDesiredCapacity(Integer desiredCapacity)

The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

Parameters:

desiredCapacity - The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

Returns:

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

setEngineVersion

public void setEngineVersion(String engineVersion)

The version of the runtime engine for the runtime environment.

Parameters:

engineVersion - The version of the runtime engine for the runtime environment.

getEngineVersion

public String getEngineVersion()

The version of the runtime engine for the runtime environment.

Returns:

The version of the runtime engine for the runtime environment.

withEngineVersion

public UpdateEnvironmentRequest withEngineVersion(String engineVersion)

The version of the runtime engine for the runtime environment.

Parameters:

engineVersion - The version of the runtime engine for the runtime environment.

Returns:

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

setEnvironmentId

public void setEnvironmentId(String environmentId)

The unique identifier of the runtime environment that you want to update.

Parameters:

environmentId - The unique identifier of the runtime environment that you want to update.

getEnvironmentId

public String getEnvironmentId()

The unique identifier of the runtime environment that you want to update.

Returns:

The unique identifier of the runtime environment that you want to update.

withEnvironmentId

public UpdateEnvironmentRequest withEnvironmentId(String environmentId)

The unique identifier of the runtime environment that you want to update.

Parameters:

environmentId - The unique identifier of the runtime environment that you want to update.

Returns:

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

setForceUpdate

public void setForceUpdate(Boolean forceUpdate)

Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

Parameters:

forceUpdate - Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

getForceUpdate

public Boolean getForceUpdate()

Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

Returns:

Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

withForceUpdate

public UpdateEnvironmentRequest withForceUpdate(Boolean forceUpdate)

Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

Parameters:

forceUpdate - Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

Returns:

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

isForceUpdate

public Boolean isForceUpdate()

Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

Returns:

Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

setInstanceType

public void setInstanceType(String instanceType)

The instance type for the runtime environment to update.

Parameters:

instanceType - The instance type for the runtime environment to update.

getInstanceType

public String getInstanceType()

The instance type for the runtime environment to update.

Returns:

The instance type for the runtime environment to update.

withInstanceType

public UpdateEnvironmentRequest withInstanceType(String instanceType)

The instance type for the runtime environment to update.

Parameters:

instanceType - The instance type for the runtime environment to update.

Returns:

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

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

Parameters:

preferredMaintenanceWindow - Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

Returns:

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

withPreferredMaintenanceWindow

public UpdateEnvironmentRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

Parameters:

preferredMaintenanceWindow - Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

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