software.amazon.awssdk.services.s3.model.SessionCredentials Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of s3 Show documentation
Show all versions of s3 Show documentation
The AWS Java SDK for Amazon S3 module holds the client classes that are used for communicating with
Amazon Simple Storage Service
/*
* 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.s3.model;
import java.io.Serializable;
import java.time.Instant;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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.core.traits.RequiredTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The established temporary security credentials of the session.
*
*
*
* Directory buckets - These session credentials are only supported for the authentication and authorization of
* Zonal endpoint APIs on directory buckets.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SessionCredentials implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ACCESS_KEY_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("AccessKeyId")
.getter(getter(SessionCredentials::accessKeyId))
.setter(setter(Builder::accessKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AccessKeyId")
.unmarshallLocationName("AccessKeyId").build(), RequiredTrait.create()).build();
private static final SdkField SECRET_ACCESS_KEY_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SecretAccessKey")
.getter(getter(SessionCredentials::secretAccessKey))
.setter(setter(Builder::secretAccessKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SecretAccessKey")
.unmarshallLocationName("SecretAccessKey").build(), RequiredTrait.create()).build();
private static final SdkField SESSION_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SessionToken")
.getter(getter(SessionCredentials::sessionToken))
.setter(setter(Builder::sessionToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SessionToken")
.unmarshallLocationName("SessionToken").build(), RequiredTrait.create()).build();
private static final SdkField EXPIRATION_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("Expiration")
.getter(getter(SessionCredentials::expiration))
.setter(setter(Builder::expiration))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Expiration")
.unmarshallLocationName("Expiration").build(), RequiredTrait.create()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ACCESS_KEY_ID_FIELD,
SECRET_ACCESS_KEY_FIELD, SESSION_TOKEN_FIELD, EXPIRATION_FIELD));
private static final long serialVersionUID = 1L;
private final String accessKeyId;
private final String secretAccessKey;
private final String sessionToken;
private final Instant expiration;
private SessionCredentials(BuilderImpl builder) {
this.accessKeyId = builder.accessKeyId;
this.secretAccessKey = builder.secretAccessKey;
this.sessionToken = builder.sessionToken;
this.expiration = builder.expiration;
}
/**
*
* A unique identifier that's associated with a secret access key. The access key ID and the secret access key are
* used together to sign programmatic Amazon Web Services requests cryptographically.
*
*
* @return A unique identifier that's associated with a secret access key. The access key ID and the secret access
* key are used together to sign programmatic Amazon Web Services requests cryptographically.
*/
public final String accessKeyId() {
return accessKeyId;
}
/**
*
* A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services requests.
* Signing a request identifies the sender and prevents the request from being altered.
*
*
* @return A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services
* requests. Signing a request identifies the sender and prevents the request from being altered.
*/
public final String secretAccessKey() {
return secretAccessKey;
}
/**
*
* A part of the temporary security credentials. The session token is used to validate the temporary security
* credentials.
*
*
* @return A part of the temporary security credentials. The session token is used to validate the temporary
* security credentials.
*/
public final String sessionToken() {
return sessionToken;
}
/**
*
* Temporary security credentials expire after a specified interval. After temporary credentials expire, any calls
* that you make with those credentials will fail. So you must generate a new set of temporary credentials.
* Temporary credentials cannot be extended or refreshed beyond the original specified interval.
*
*
* @return Temporary security credentials expire after a specified interval. After temporary credentials expire, any
* calls that you make with those credentials will fail. So you must generate a new set of temporary
* credentials. Temporary credentials cannot be extended or refreshed beyond the original specified
* interval.
*/
public final Instant expiration() {
return expiration;
}
@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 + Objects.hashCode(accessKeyId());
hashCode = 31 * hashCode + Objects.hashCode(secretAccessKey());
hashCode = 31 * hashCode + Objects.hashCode(sessionToken());
hashCode = 31 * hashCode + Objects.hashCode(expiration());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SessionCredentials)) {
return false;
}
SessionCredentials other = (SessionCredentials) obj;
return Objects.equals(accessKeyId(), other.accessKeyId()) && Objects.equals(secretAccessKey(), other.secretAccessKey())
&& Objects.equals(sessionToken(), other.sessionToken()) && Objects.equals(expiration(), other.expiration());
}
/**
* 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("SessionCredentials").add("AccessKeyId", accessKeyId())
.add("SecretAccessKey", secretAccessKey() == null ? null : "*** Sensitive Data Redacted ***")
.add("SessionToken", sessionToken() == null ? null : "*** Sensitive Data Redacted ***")
.add("Expiration", expiration()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AccessKeyId":
return Optional.ofNullable(clazz.cast(accessKeyId()));
case "SecretAccessKey":
return Optional.ofNullable(clazz.cast(secretAccessKey()));
case "SessionToken":
return Optional.ofNullable(clazz.cast(sessionToken()));
case "Expiration":
return Optional.ofNullable(clazz.cast(expiration()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SessionCredentials) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A unique identifier that's associated with a secret access key. The access key ID and the secret access key
* are used together to sign programmatic Amazon Web Services requests cryptographically.
*
*
* @param accessKeyId
* A unique identifier that's associated with a secret access key. The access key ID and the secret
* access key are used together to sign programmatic Amazon Web Services requests cryptographically.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder accessKeyId(String accessKeyId);
/**
*
* A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services requests.
* Signing a request identifies the sender and prevents the request from being altered.
*
*
* @param secretAccessKey
* A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services
* requests. Signing a request identifies the sender and prevents the request from being altered.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder secretAccessKey(String secretAccessKey);
/**
*
* A part of the temporary security credentials. The session token is used to validate the temporary security
* credentials.
*
*
* @param sessionToken
* A part of the temporary security credentials. The session token is used to validate the temporary
* security credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sessionToken(String sessionToken);
/**
*
* Temporary security credentials expire after a specified interval. After temporary credentials expire, any
* calls that you make with those credentials will fail. So you must generate a new set of temporary
* credentials. Temporary credentials cannot be extended or refreshed beyond the original specified interval.
*
*
* @param expiration
* Temporary security credentials expire after a specified interval. After temporary credentials expire,
* any calls that you make with those credentials will fail. So you must generate a new set of temporary
* credentials. Temporary credentials cannot be extended or refreshed beyond the original specified
* interval.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expiration(Instant expiration);
}
static final class BuilderImpl implements Builder {
private String accessKeyId;
private String secretAccessKey;
private String sessionToken;
private Instant expiration;
private BuilderImpl() {
}
private BuilderImpl(SessionCredentials model) {
accessKeyId(model.accessKeyId);
secretAccessKey(model.secretAccessKey);
sessionToken(model.sessionToken);
expiration(model.expiration);
}
public final String getAccessKeyId() {
return accessKeyId;
}
public final void setAccessKeyId(String accessKeyId) {
this.accessKeyId = accessKeyId;
}
@Override
public final Builder accessKeyId(String accessKeyId) {
this.accessKeyId = accessKeyId;
return this;
}
public final String getSecretAccessKey() {
return secretAccessKey;
}
public final void setSecretAccessKey(String secretAccessKey) {
this.secretAccessKey = secretAccessKey;
}
@Override
public final Builder secretAccessKey(String secretAccessKey) {
this.secretAccessKey = secretAccessKey;
return this;
}
public final String getSessionToken() {
return sessionToken;
}
public final void setSessionToken(String sessionToken) {
this.sessionToken = sessionToken;
}
@Override
public final Builder sessionToken(String sessionToken) {
this.sessionToken = sessionToken;
return this;
}
public final Instant getExpiration() {
return expiration;
}
public final void setExpiration(Instant expiration) {
this.expiration = expiration;
}
@Override
public final Builder expiration(Instant expiration) {
this.expiration = expiration;
return this;
}
@Override
public SessionCredentials build() {
return new SessionCredentials(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy