software.amazon.awssdk.services.iam.model.SetSecurityTokenServicePreferencesRequest Maven / Gradle / Ivy
Show all versions of iam 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.iam.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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 SetSecurityTokenServicePreferencesRequest extends IamRequest implements
ToCopyableBuilder {
private static final SdkField GLOBAL_ENDPOINT_TOKEN_VERSION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("GlobalEndpointTokenVersion")
.getter(getter(SetSecurityTokenServicePreferencesRequest::globalEndpointTokenVersionAsString))
.setter(setter(Builder::globalEndpointTokenVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GlobalEndpointTokenVersion").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays
.asList(GLOBAL_ENDPOINT_TOKEN_VERSION_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String globalEndpointTokenVersion;
private SetSecurityTokenServicePreferencesRequest(BuilderImpl builder) {
super(builder);
this.globalEndpointTokenVersion = builder.globalEndpointTokenVersion;
}
/**
*
* The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are
* available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong).
* Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where
* you temporarily store tokens.
*
*
* For information, see Activating and
* deactivating STS in an Amazon Web Services Region in the IAM User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #globalEndpointTokenVersion} will return {@link GlobalEndpointTokenVersion#UNKNOWN_TO_SDK_VERSION}. The
* raw value returned by the service is available from {@link #globalEndpointTokenVersionAsString}.
*
*
* @return The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions
* that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific
* (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might
* affect systems where you temporarily store tokens.
*
* For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
* @see GlobalEndpointTokenVersion
*/
public final GlobalEndpointTokenVersion globalEndpointTokenVersion() {
return GlobalEndpointTokenVersion.fromValue(globalEndpointTokenVersion);
}
/**
*
* The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are
* available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong).
* Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where
* you temporarily store tokens.
*
*
* For information, see Activating and
* deactivating STS in an Amazon Web Services Region in the IAM User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #globalEndpointTokenVersion} will return {@link GlobalEndpointTokenVersion#UNKNOWN_TO_SDK_VERSION}. The
* raw value returned by the service is available from {@link #globalEndpointTokenVersionAsString}.
*
*
* @return The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions
* that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific
* (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might
* affect systems where you temporarily store tokens.
*
* For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
* @see GlobalEndpointTokenVersion
*/
public final String globalEndpointTokenVersionAsString() {
return globalEndpointTokenVersion;
}
@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(globalEndpointTokenVersionAsString());
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 SetSecurityTokenServicePreferencesRequest)) {
return false;
}
SetSecurityTokenServicePreferencesRequest other = (SetSecurityTokenServicePreferencesRequest) obj;
return Objects.equals(globalEndpointTokenVersionAsString(), other.globalEndpointTokenVersionAsString());
}
/**
* 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("SetSecurityTokenServicePreferencesRequest")
.add("GlobalEndpointTokenVersion", globalEndpointTokenVersionAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "GlobalEndpointTokenVersion":
return Optional.ofNullable(clazz.cast(globalEndpointTokenVersionAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("GlobalEndpointTokenVersion", GLOBAL_ENDPOINT_TOKEN_VERSION_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((SetSecurityTokenServicePreferencesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that
* are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong
* Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect
* systems where you temporarily store tokens.
*
*
* For information, see Activating
* and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
*
*
* @param globalEndpointTokenVersion
* The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services
* Regions that are available by default. These tokens do not work in manually enabled Regions, such as
* Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are
* longer and might affect systems where you temporarily store tokens.
*
* For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
* @see GlobalEndpointTokenVersion
* @return Returns a reference to this object so that method calls can be chained together.
* @see GlobalEndpointTokenVersion
*/
Builder globalEndpointTokenVersion(String globalEndpointTokenVersion);
/**
*
* The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that
* are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong
* Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect
* systems where you temporarily store tokens.
*
*
* For information, see Activating
* and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
*
*
* @param globalEndpointTokenVersion
* The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services
* Regions that are available by default. These tokens do not work in manually enabled Regions, such as
* Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are
* longer and might affect systems where you temporarily store tokens.
*
* For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
* @see GlobalEndpointTokenVersion
* @return Returns a reference to this object so that method calls can be chained together.
* @see GlobalEndpointTokenVersion
*/
Builder globalEndpointTokenVersion(GlobalEndpointTokenVersion globalEndpointTokenVersion);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IamRequest.BuilderImpl implements Builder {
private String globalEndpointTokenVersion;
private BuilderImpl() {
}
private BuilderImpl(SetSecurityTokenServicePreferencesRequest model) {
super(model);
globalEndpointTokenVersion(model.globalEndpointTokenVersion);
}
public final String getGlobalEndpointTokenVersion() {
return globalEndpointTokenVersion;
}
public final void setGlobalEndpointTokenVersion(String globalEndpointTokenVersion) {
this.globalEndpointTokenVersion = globalEndpointTokenVersion;
}
@Override
public final Builder globalEndpointTokenVersion(String globalEndpointTokenVersion) {
this.globalEndpointTokenVersion = globalEndpointTokenVersion;
return this;
}
@Override
public final Builder globalEndpointTokenVersion(GlobalEndpointTokenVersion globalEndpointTokenVersion) {
this.globalEndpointTokenVersion(globalEndpointTokenVersion == null ? null : globalEndpointTokenVersion.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 SetSecurityTokenServicePreferencesRequest build() {
return new SetSecurityTokenServicePreferencesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}