software.amazon.awssdk.services.iam.model.CreateSamlProviderRequest 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.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 CreateSamlProviderRequest extends IamRequest implements
ToCopyableBuilder {
private static final SdkField SAML_METADATA_DOCUMENT_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateSamlProviderRequest::samlMetadataDocument)).setter(setter(Builder::samlMetadataDocument))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SAMLMetadataDocument").build())
.build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateSamlProviderRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SAML_METADATA_DOCUMENT_FIELD,
NAME_FIELD));
private final String samlMetadataDocument;
private final String name;
private CreateSamlProviderRequest(BuilderImpl builder) {
super(builder);
this.samlMetadataDocument = builder.samlMetadataDocument;
this.name = builder.name;
}
/**
*
* An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the
* issuer's name, expiration information, and keys that can be used to validate the SAML authentication response
* (assertions) that are received from the IdP. You must generate the metadata document using the identity
* management software that is used as your organization's IdP.
*
*
* For more information, see About SAML 2.0-based
* Federation in the IAM User Guide
*
*
* @return An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the
* issuer's name, expiration information, and keys that can be used to validate the SAML authentication
* response (assertions) that are received from the IdP. You must generate the metadata document using the
* identity management software that is used as your organization's IdP.
*
* For more information, see About SAML 2.0-based
* Federation in the IAM User Guide
*/
public String samlMetadataDocument() {
return samlMetadataDocument;
}
/**
*
* The name of the provider to create.
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
* the following characters: _+=,.@-
*
*
* @return The name of the provider to create.
*
* This parameter allows (through its regex pattern) a string
* of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also
* include any of the following characters: _+=,.@-
*/
public String name() {
return name;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(samlMetadataDocument());
hashCode = 31 * hashCode + Objects.hashCode(name());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateSamlProviderRequest)) {
return false;
}
CreateSamlProviderRequest other = (CreateSamlProviderRequest) obj;
return Objects.equals(samlMetadataDocument(), other.samlMetadataDocument()) && Objects.equals(name(), other.name());
}
/**
* 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 String toString() {
return ToString.builder("CreateSamlProviderRequest").add("SAMLMetadataDocument", samlMetadataDocument())
.add("Name", name()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SAMLMetadataDocument":
return Optional.ofNullable(clazz.cast(samlMetadataDocument()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateSamlProviderRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the
* issuer's name, expiration information, and keys that can be used to validate the SAML authentication response
* (assertions) that are received from the IdP. You must generate the metadata document using the identity
* management software that is used as your organization's IdP.
*
*
* For more information, see About SAML 2.0-based
* Federation in the IAM User Guide
*
*
* @param samlMetadataDocument
* An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes
* the issuer's name, expiration information, and keys that can be used to validate the SAML
* authentication response (assertions) that are received from the IdP. You must generate the metadata
* document using the identity management software that is used as your organization's IdP.
*
* For more information, see About SAML
* 2.0-based Federation in the IAM User Guide
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder samlMetadataDocument(String samlMetadataDocument);
/**
*
* The name of the provider to create.
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any
* of the following characters: _+=,.@-
*
*
* @param name
* The name of the provider to create.
*
* This parameter allows (through its regex pattern) a
* string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can
* also include any of the following characters: _+=,.@-
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IamRequest.BuilderImpl implements Builder {
private String samlMetadataDocument;
private String name;
private BuilderImpl() {
}
private BuilderImpl(CreateSamlProviderRequest model) {
super(model);
samlMetadataDocument(model.samlMetadataDocument);
name(model.name);
}
public final String getSamlMetadataDocument() {
return samlMetadataDocument;
}
@Override
public final Builder samlMetadataDocument(String samlMetadataDocument) {
this.samlMetadataDocument = samlMetadataDocument;
return this;
}
public final void setSamlMetadataDocument(String samlMetadataDocument) {
this.samlMetadataDocument = samlMetadataDocument;
}
public final String getName() {
return name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final void setName(String name) {
this.name = name;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateSamlProviderRequest build() {
return new CreateSamlProviderRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}