software.amazon.awssdk.services.cloud9.model.UpdateEnvironmentRequest Maven / Gradle / Ivy
Show all versions of cloud9 Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cloud9.model;
import java.beans.Transient;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpdateEnvironmentRequest extends Cloud9Request implements
ToCopyableBuilder {
private static final SdkField ENVIRONMENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("environmentId").getter(getter(UpdateEnvironmentRequest::environmentId))
.setter(setter(Builder::environmentId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("environmentId").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(UpdateEnvironmentRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(UpdateEnvironmentRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField MANAGED_CREDENTIALS_ACTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("managedCredentialsAction").getter(getter(UpdateEnvironmentRequest::managedCredentialsActionAsString))
.setter(setter(Builder::managedCredentialsAction))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("managedCredentialsAction").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ENVIRONMENT_ID_FIELD,
NAME_FIELD, DESCRIPTION_FIELD, MANAGED_CREDENTIALS_ACTION_FIELD));
private final String environmentId;
private final String name;
private final String description;
private final String managedCredentialsAction;
private UpdateEnvironmentRequest(BuilderImpl builder) {
super(builder);
this.environmentId = builder.environmentId;
this.name = builder.name;
this.description = builder.description;
this.managedCredentialsAction = builder.managedCredentialsAction;
}
/**
*
* The ID of the environment to change settings.
*
*
* @return The ID of the environment to change settings.
*/
public final String environmentId() {
return environmentId;
}
/**
*
* A replacement name for the environment.
*
*
* @return A replacement name for the environment.
*/
public final String name() {
return name;
}
/**
*
* Any new or replacement description for the environment.
*
*
* @return Any new or replacement description for the environment.
*/
public final String description() {
return description;
}
/**
*
* Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary credentials for an
* Cloud9 environment by using one of the following values:
*
*
* -
*
* ENABLE
*
*
* -
*
* DISABLE
*
*
*
*
*
* Only the environment owner can change the status of managed temporary credentials. An
* AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary credentials
* is made by an account that's not the environment owner.
*
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #managedCredentialsAction} will return {@link ManagedCredentialsAction#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #managedCredentialsActionAsString}.
*
*
* @return Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary credentials
* for an Cloud9 environment by using one of the following values:
*
* -
*
* ENABLE
*
*
* -
*
* DISABLE
*
*
*
*
*
* Only the environment owner can change the status of managed temporary credentials. An
* AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary
* credentials is made by an account that's not the environment owner.
*
* @see ManagedCredentialsAction
*/
public final ManagedCredentialsAction managedCredentialsAction() {
return ManagedCredentialsAction.fromValue(managedCredentialsAction);
}
/**
*
* Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary credentials for an
* Cloud9 environment by using one of the following values:
*
*
* -
*
* ENABLE
*
*
* -
*
* DISABLE
*
*
*
*
*
* Only the environment owner can change the status of managed temporary credentials. An
* AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary credentials
* is made by an account that's not the environment owner.
*
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #managedCredentialsAction} will return {@link ManagedCredentialsAction#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #managedCredentialsActionAsString}.
*
*
* @return Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary credentials
* for an Cloud9 environment by using one of the following values:
*
* -
*
* ENABLE
*
*
* -
*
* DISABLE
*
*
*
*
*
* Only the environment owner can change the status of managed temporary credentials. An
* AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary
* credentials is made by an account that's not the environment owner.
*
* @see ManagedCredentialsAction
*/
public final String managedCredentialsActionAsString() {
return managedCredentialsAction;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(environmentId());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(managedCredentialsActionAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UpdateEnvironmentRequest)) {
return false;
}
UpdateEnvironmentRequest other = (UpdateEnvironmentRequest) obj;
return Objects.equals(environmentId(), other.environmentId()) && Objects.equals(name(), other.name())
&& Objects.equals(description(), other.description())
&& Objects.equals(managedCredentialsActionAsString(), other.managedCredentialsActionAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("UpdateEnvironmentRequest").add("EnvironmentId", environmentId()).add("Name", name())
.add("Description", description() == null ? null : "*** Sensitive Data Redacted ***")
.add("ManagedCredentialsAction", managedCredentialsActionAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "environmentId":
return Optional.ofNullable(clazz.cast(environmentId()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "managedCredentialsAction":
return Optional.ofNullable(clazz.cast(managedCredentialsActionAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateEnvironmentRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Cloud9Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the environment to change settings.
*
*
* @param environmentId
* The ID of the environment to change settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environmentId(String environmentId);
/**
*
* A replacement name for the environment.
*
*
* @param name
* A replacement name for the environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* Any new or replacement description for the environment.
*
*
* @param description
* Any new or replacement description for the environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary credentials for
* an Cloud9 environment by using one of the following values:
*
*
* -
*
* ENABLE
*
*
* -
*
* DISABLE
*
*
*
*
*
* Only the environment owner can change the status of managed temporary credentials. An
* AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary
* credentials is made by an account that's not the environment owner.
*
*
*
* @param managedCredentialsAction
* Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary
* credentials for an Cloud9 environment by using one of the following values:
*
* -
*
* ENABLE
*
*
* -
*
* DISABLE
*
*
*
*
*
* Only the environment owner can change the status of managed temporary credentials. An
* AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary
* credentials is made by an account that's not the environment owner.
*
* @see ManagedCredentialsAction
* @return Returns a reference to this object so that method calls can be chained together.
* @see ManagedCredentialsAction
*/
Builder managedCredentialsAction(String managedCredentialsAction);
/**
*
* Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary credentials for
* an Cloud9 environment by using one of the following values:
*
*
* -
*
* ENABLE
*
*
* -
*
* DISABLE
*
*
*
*
*
* Only the environment owner can change the status of managed temporary credentials. An
* AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary
* credentials is made by an account that's not the environment owner.
*
*
*
* @param managedCredentialsAction
* Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary
* credentials for an Cloud9 environment by using one of the following values:
*
* -
*
* ENABLE
*
*
* -
*
* DISABLE
*
*
*
*
*
* Only the environment owner can change the status of managed temporary credentials. An
* AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary
* credentials is made by an account that's not the environment owner.
*
* @see ManagedCredentialsAction
* @return Returns a reference to this object so that method calls can be chained together.
* @see ManagedCredentialsAction
*/
Builder managedCredentialsAction(ManagedCredentialsAction managedCredentialsAction);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends Cloud9Request.BuilderImpl implements Builder {
private String environmentId;
private String name;
private String description;
private String managedCredentialsAction;
private BuilderImpl() {
}
private BuilderImpl(UpdateEnvironmentRequest model) {
super(model);
environmentId(model.environmentId);
name(model.name);
description(model.description);
managedCredentialsAction(model.managedCredentialsAction);
}
public final String getEnvironmentId() {
return environmentId;
}
public final void setEnvironmentId(String environmentId) {
this.environmentId = environmentId;
}
@Override
@Transient
public final Builder environmentId(String environmentId) {
this.environmentId = environmentId;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
@Transient
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
@Transient
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getManagedCredentialsAction() {
return managedCredentialsAction;
}
public final void setManagedCredentialsAction(String managedCredentialsAction) {
this.managedCredentialsAction = managedCredentialsAction;
}
@Override
@Transient
public final Builder managedCredentialsAction(String managedCredentialsAction) {
this.managedCredentialsAction = managedCredentialsAction;
return this;
}
@Override
@Transient
public final Builder managedCredentialsAction(ManagedCredentialsAction managedCredentialsAction) {
this.managedCredentialsAction(managedCredentialsAction == null ? null : managedCredentialsAction.toString());
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public UpdateEnvironmentRequest build() {
return new UpdateEnvironmentRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}