software.amazon.awssdk.services.iam.model.GetSamlProviderResponse 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.time.Instant;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains the response to a successful GetSAMLProvider request.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetSamlProviderResponse extends IamResponse implements
ToCopyableBuilder {
private static final SdkField SAML_METADATA_DOCUMENT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SAMLMetadataDocument").getter(getter(GetSamlProviderResponse::samlMetadataDocument))
.setter(setter(Builder::samlMetadataDocument))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SAMLMetadataDocument").build())
.build();
private static final SdkField CREATE_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreateDate").getter(getter(GetSamlProviderResponse::createDate)).setter(setter(Builder::createDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreateDate").build()).build();
private static final SdkField VALID_UNTIL_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("ValidUntil").getter(getter(GetSamlProviderResponse::validUntil)).setter(setter(Builder::validUntil))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ValidUntil").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(GetSamlProviderResponse::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SAML_METADATA_DOCUMENT_FIELD,
CREATE_DATE_FIELD, VALID_UNTIL_FIELD, TAGS_FIELD));
private final String samlMetadataDocument;
private final Instant createDate;
private final Instant validUntil;
private final List tags;
private GetSamlProviderResponse(BuilderImpl builder) {
super(builder);
this.samlMetadataDocument = builder.samlMetadataDocument;
this.createDate = builder.createDate;
this.validUntil = builder.validUntil;
this.tags = builder.tags;
}
/**
*
* The XML metadata document that includes information about an identity provider.
*
*
* @return The XML metadata document that includes information about an identity provider.
*/
public final String samlMetadataDocument() {
return samlMetadataDocument;
}
/**
*
* The date and time when the SAML provider was created.
*
*
* @return The date and time when the SAML provider was created.
*/
public final Instant createDate() {
return createDate;
}
/**
*
* The expiration date and time for the SAML provider.
*
*
* @return The expiration date and time for the SAML provider.
*/
public final Instant validUntil() {
return validUntil;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag
* key. For more information about tagging, see Tagging IAM resources in the IAM User
* Guide.
*
*
* 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 #hasTags} method.
*
*
* @return A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted
* by tag key. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*/
public final List tags() {
return tags;
}
@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(samlMetadataDocument());
hashCode = 31 * hashCode + Objects.hashCode(createDate());
hashCode = 31 * hashCode + Objects.hashCode(validUntil());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 GetSamlProviderResponse)) {
return false;
}
GetSamlProviderResponse other = (GetSamlProviderResponse) obj;
return Objects.equals(samlMetadataDocument(), other.samlMetadataDocument())
&& Objects.equals(createDate(), other.createDate()) && Objects.equals(validUntil(), other.validUntil())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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("GetSamlProviderResponse").add("SAMLMetadataDocument", samlMetadataDocument())
.add("CreateDate", createDate()).add("ValidUntil", validUntil()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SAMLMetadataDocument":
return Optional.ofNullable(clazz.cast(samlMetadataDocument()));
case "CreateDate":
return Optional.ofNullable(clazz.cast(createDate()));
case "ValidUntil":
return Optional.ofNullable(clazz.cast(validUntil()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetSamlProviderResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The XML metadata document that includes information about an identity provider.
*
*
* @param samlMetadataDocument
* The XML metadata document that includes information about an identity provider.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder samlMetadataDocument(String samlMetadataDocument);
/**
*
* The date and time when the SAML provider was created.
*
*
* @param createDate
* The date and time when the SAML provider was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createDate(Instant createDate);
/**
*
* The expiration date and time for the SAML provider.
*
*
* @param validUntil
* The expiration date and time for the SAML provider.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder validUntil(Instant validUntil);
/**
*
* A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by
* tag key. For more information about tagging, see Tagging IAM resources in the IAM
* User Guide.
*
*
* @param tags
* A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is
* sorted by tag key. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by
* tag key. For more information about tagging, see Tagging IAM resources in the IAM
* User Guide.
*
*
* @param tags
* A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is
* sorted by tag key. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by
* tag key. For more information about tagging, see Tagging IAM resources in the IAM
* User Guide.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.iam.model.Tag.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.iam.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.iam.model.Tag.Builder#build()} is
* called immediately and its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link software.amazon.awssdk.services.iam.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
}
static final class BuilderImpl extends IamResponse.BuilderImpl implements Builder {
private String samlMetadataDocument;
private Instant createDate;
private Instant validUntil;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetSamlProviderResponse model) {
super(model);
samlMetadataDocument(model.samlMetadataDocument);
createDate(model.createDate);
validUntil(model.validUntil);
tags(model.tags);
}
public final String getSamlMetadataDocument() {
return samlMetadataDocument;
}
public final void setSamlMetadataDocument(String samlMetadataDocument) {
this.samlMetadataDocument = samlMetadataDocument;
}
@Override
public final Builder samlMetadataDocument(String samlMetadataDocument) {
this.samlMetadataDocument = samlMetadataDocument;
return this;
}
public final Instant getCreateDate() {
return createDate;
}
public final void setCreateDate(Instant createDate) {
this.createDate = createDate;
}
@Override
public final Builder createDate(Instant createDate) {
this.createDate = createDate;
return this;
}
public final Instant getValidUntil() {
return validUntil;
}
public final void setValidUntil(Instant validUntil) {
this.validUntil = validUntil;
}
@Override
public final Builder validUntil(Instant validUntil) {
this.validUntil = validUntil;
return this;
}
public final List getTags() {
List result = _tagListTypeCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = _tagListTypeCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = _tagListTypeCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public GetSamlProviderResponse build() {
return new GetSamlProviderResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}