software.amazon.awssdk.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityRequest Maven / Gradle / Ivy
Show all versions of cognitoidentity 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.cognitoidentity.model;
import java.util.Arrays;
import java.util.Collections;
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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Input to the GetOpenIdTokenForDeveloperIdentity action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetOpenIdTokenForDeveloperIdentityRequest extends CognitoIdentityRequest implements
ToCopyableBuilder {
private static final SdkField IDENTITY_POOL_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("IdentityPoolId").getter(getter(GetOpenIdTokenForDeveloperIdentityRequest::identityPoolId))
.setter(setter(Builder::identityPoolId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IdentityPoolId").build()).build();
private static final SdkField IDENTITY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("IdentityId").getter(getter(GetOpenIdTokenForDeveloperIdentityRequest::identityId))
.setter(setter(Builder::identityId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IdentityId").build()).build();
private static final SdkField> LOGINS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Logins")
.getter(getter(GetOpenIdTokenForDeveloperIdentityRequest::logins))
.setter(setter(Builder::logins))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Logins").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField> PRINCIPAL_TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("PrincipalTags")
.getter(getter(GetOpenIdTokenForDeveloperIdentityRequest::principalTags))
.setter(setter(Builder::principalTags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PrincipalTags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField TOKEN_DURATION_FIELD = SdkField. builder(MarshallingType.LONG)
.memberName("TokenDuration").getter(getter(GetOpenIdTokenForDeveloperIdentityRequest::tokenDuration))
.setter(setter(Builder::tokenDuration))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TokenDuration").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(IDENTITY_POOL_ID_FIELD,
IDENTITY_ID_FIELD, LOGINS_FIELD, PRINCIPAL_TAGS_FIELD, TOKEN_DURATION_FIELD));
private final String identityPoolId;
private final String identityId;
private final Map logins;
private final Map principalTags;
private final Long tokenDuration;
private GetOpenIdTokenForDeveloperIdentityRequest(BuilderImpl builder) {
super(builder);
this.identityPoolId = builder.identityPoolId;
this.identityId = builder.identityId;
this.logins = builder.logins;
this.principalTags = builder.principalTags;
this.tokenDuration = builder.tokenDuration;
}
/**
*
* An identity pool ID in the format REGION:GUID.
*
*
* @return An identity pool ID in the format REGION:GUID.
*/
public final String identityPoolId() {
return identityPoolId;
}
/**
*
* A unique identifier in the format REGION:GUID.
*
*
* @return A unique identifier in the format REGION:GUID.
*/
public final String identityId() {
return identityId;
}
/**
* For responses, this returns true if the service returned a value for the Logins property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasLogins() {
return logins != null && !(logins instanceof SdkAutoConstructMap);
}
/**
*
* A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a
* user from a public provider or developer provider. If the user is from a developer provider, the name-value pair
* will follow the syntax "developer_provider_name": "developer_user_identifier". The developer
* provider is the "domain" by which Cognito will refer to your users; you provided this domain while
* creating/updating the identity pool. The developer user identifier is an identifier from your backend that
* uniquely identifies a user. When you create an identity pool, you can specify the supported logins.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasLogins} method.
*
*
* @return A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair
* represents a user from a public provider or developer provider. If the user is from a developer provider,
* the name-value pair will follow the syntax
* "developer_provider_name": "developer_user_identifier". The developer provider is the
* "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the
* identity pool. The developer user identifier is an identifier from your backend that uniquely identifies
* a user. When you create an identity pool, you can specify the supported logins.
*/
public final Map logins() {
return logins;
}
/**
* For responses, this returns true if the service returned a value for the PrincipalTags property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasPrincipalTags() {
return principalTags != null && !(principalTags instanceof SdkAutoConstructMap);
}
/**
*
* Use this operation to configure attribute mappings for custom providers.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasPrincipalTags} method.
*
*
* @return Use this operation to configure attribute mappings for custom providers.
*/
public final Map principalTags() {
return principalTags;
}
/**
*
* The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you
* can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the
* token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token
* duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are
* significant security implications: an attacker could use a leaked token to access your AWS resources for the
* token's duration.
*
*
*
* Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.
*
*
*
* @return The expiration time of the token, in seconds. You can specify a custom expiration time for the token so
* that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You
* can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of
* one hour. The maximum token duration you can set is 24 hours. You should take care in setting the
* expiration time for a token, as there are significant security implications: an attacker could use a
* leaked token to access your AWS resources for the token's duration.
*
* Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.
*
*/
public final Long tokenDuration() {
return tokenDuration;
}
@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(identityPoolId());
hashCode = 31 * hashCode + Objects.hashCode(identityId());
hashCode = 31 * hashCode + Objects.hashCode(hasLogins() ? logins() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasPrincipalTags() ? principalTags() : null);
hashCode = 31 * hashCode + Objects.hashCode(tokenDuration());
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 GetOpenIdTokenForDeveloperIdentityRequest)) {
return false;
}
GetOpenIdTokenForDeveloperIdentityRequest other = (GetOpenIdTokenForDeveloperIdentityRequest) obj;
return Objects.equals(identityPoolId(), other.identityPoolId()) && Objects.equals(identityId(), other.identityId())
&& hasLogins() == other.hasLogins() && Objects.equals(logins(), other.logins())
&& hasPrincipalTags() == other.hasPrincipalTags() && Objects.equals(principalTags(), other.principalTags())
&& Objects.equals(tokenDuration(), other.tokenDuration());
}
/**
* 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("GetOpenIdTokenForDeveloperIdentityRequest").add("IdentityPoolId", identityPoolId())
.add("IdentityId", identityId()).add("Logins", hasLogins() ? logins() : null)
.add("PrincipalTags", hasPrincipalTags() ? principalTags() : null).add("TokenDuration", tokenDuration()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "IdentityPoolId":
return Optional.ofNullable(clazz.cast(identityPoolId()));
case "IdentityId":
return Optional.ofNullable(clazz.cast(identityId()));
case "Logins":
return Optional.ofNullable(clazz.cast(logins()));
case "PrincipalTags":
return Optional.ofNullable(clazz.cast(principalTags()));
case "TokenDuration":
return Optional.ofNullable(clazz.cast(tokenDuration()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetOpenIdTokenForDeveloperIdentityRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CognitoIdentityRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* An identity pool ID in the format REGION:GUID.
*
*
* @param identityPoolId
* An identity pool ID in the format REGION:GUID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder identityPoolId(String identityPoolId);
/**
*
* A unique identifier in the format REGION:GUID.
*
*
* @param identityId
* A unique identifier in the format REGION:GUID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder identityId(String identityId);
/**
*
* A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair
* represents a user from a public provider or developer provider. If the user is from a developer provider, the
* name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier".
* The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain
* while creating/updating the identity pool. The developer user identifier is an identifier from your backend
* that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.
*
*
* @param logins
* A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair
* represents a user from a public provider or developer provider. If the user is from a developer
* provider, the name-value pair will follow the syntax
* "developer_provider_name": "developer_user_identifier". The developer provider is the
* "domain" by which Cognito will refer to your users; you provided this domain while creating/updating
* the identity pool. The developer user identifier is an identifier from your backend that uniquely
* identifies a user. When you create an identity pool, you can specify the supported logins.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder logins(Map logins);
/**
*
* Use this operation to configure attribute mappings for custom providers.
*
*
* @param principalTags
* Use this operation to configure attribute mappings for custom providers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principalTags(Map principalTags);
/**
*
* The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that
* you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can
* exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour.
* The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a
* token, as there are significant security implications: an attacker could use a leaked token to access your
* AWS resources for the token's duration.
*
*
*
* Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.
*
*
*
* @param tokenDuration
* The expiration time of the token, in seconds. You can specify a custom expiration time for the token
* so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes.
* You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a
* maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in
* setting the expiration time for a token, as there are significant security implications: an attacker
* could use a leaked token to access your AWS resources for the token's duration.
*
* Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tokenDuration(Long tokenDuration);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CognitoIdentityRequest.BuilderImpl implements Builder {
private String identityPoolId;
private String identityId;
private Map logins = DefaultSdkAutoConstructMap.getInstance();
private Map principalTags = DefaultSdkAutoConstructMap.getInstance();
private Long tokenDuration;
private BuilderImpl() {
}
private BuilderImpl(GetOpenIdTokenForDeveloperIdentityRequest model) {
super(model);
identityPoolId(model.identityPoolId);
identityId(model.identityId);
logins(model.logins);
principalTags(model.principalTags);
tokenDuration(model.tokenDuration);
}
public final String getIdentityPoolId() {
return identityPoolId;
}
public final void setIdentityPoolId(String identityPoolId) {
this.identityPoolId = identityPoolId;
}
@Override
public final Builder identityPoolId(String identityPoolId) {
this.identityPoolId = identityPoolId;
return this;
}
public final String getIdentityId() {
return identityId;
}
public final void setIdentityId(String identityId) {
this.identityId = identityId;
}
@Override
public final Builder identityId(String identityId) {
this.identityId = identityId;
return this;
}
public final Map getLogins() {
if (logins instanceof SdkAutoConstructMap) {
return null;
}
return logins;
}
public final void setLogins(Map logins) {
this.logins = LoginsMapCopier.copy(logins);
}
@Override
public final Builder logins(Map logins) {
this.logins = LoginsMapCopier.copy(logins);
return this;
}
public final Map getPrincipalTags() {
if (principalTags instanceof SdkAutoConstructMap) {
return null;
}
return principalTags;
}
public final void setPrincipalTags(Map principalTags) {
this.principalTags = PrincipalTagsCopier.copy(principalTags);
}
@Override
public final Builder principalTags(Map principalTags) {
this.principalTags = PrincipalTagsCopier.copy(principalTags);
return this;
}
public final Long getTokenDuration() {
return tokenDuration;
}
public final void setTokenDuration(Long tokenDuration) {
this.tokenDuration = tokenDuration;
}
@Override
public final Builder tokenDuration(Long tokenDuration) {
this.tokenDuration = tokenDuration;
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 GetOpenIdTokenForDeveloperIdentityRequest build() {
return new GetOpenIdTokenForDeveloperIdentityRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}