software.amazon.awssdk.services.appstream.model.UpdateDirectoryConfigRequest Maven / Gradle / Ivy
Show all versions of appstream 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.appstream.model;
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 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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpdateDirectoryConfigRequest extends AppStreamRequest implements
ToCopyableBuilder {
private static final SdkField DIRECTORY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DirectoryName").getter(getter(UpdateDirectoryConfigRequest::directoryName))
.setter(setter(Builder::directoryName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DirectoryName").build()).build();
private static final SdkField> ORGANIZATIONAL_UNIT_DISTINGUISHED_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("OrganizationalUnitDistinguishedNames")
.getter(getter(UpdateDirectoryConfigRequest::organizationalUnitDistinguishedNames))
.setter(setter(Builder::organizationalUnitDistinguishedNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("OrganizationalUnitDistinguishedNames").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SERVICE_ACCOUNT_CREDENTIALS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ServiceAccountCredentials")
.getter(getter(UpdateDirectoryConfigRequest::serviceAccountCredentials))
.setter(setter(Builder::serviceAccountCredentials)).constructor(ServiceAccountCredentials::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServiceAccountCredentials").build())
.build();
private static final SdkField CERTIFICATE_BASED_AUTH_PROPERTIES_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("CertificateBasedAuthProperties")
.getter(getter(UpdateDirectoryConfigRequest::certificateBasedAuthProperties))
.setter(setter(Builder::certificateBasedAuthProperties))
.constructor(CertificateBasedAuthProperties::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CertificateBasedAuthProperties")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DIRECTORY_NAME_FIELD,
ORGANIZATIONAL_UNIT_DISTINGUISHED_NAMES_FIELD, SERVICE_ACCOUNT_CREDENTIALS_FIELD,
CERTIFICATE_BASED_AUTH_PROPERTIES_FIELD));
private final String directoryName;
private final List organizationalUnitDistinguishedNames;
private final ServiceAccountCredentials serviceAccountCredentials;
private final CertificateBasedAuthProperties certificateBasedAuthProperties;
private UpdateDirectoryConfigRequest(BuilderImpl builder) {
super(builder);
this.directoryName = builder.directoryName;
this.organizationalUnitDistinguishedNames = builder.organizationalUnitDistinguishedNames;
this.serviceAccountCredentials = builder.serviceAccountCredentials;
this.certificateBasedAuthProperties = builder.certificateBasedAuthProperties;
}
/**
*
* The name of the Directory Config object.
*
*
* @return The name of the Directory Config object.
*/
public final String directoryName() {
return directoryName;
}
/**
* For responses, this returns true if the service returned a value for the OrganizationalUnitDistinguishedNames
* 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 hasOrganizationalUnitDistinguishedNames() {
return organizationalUnitDistinguishedNames != null
&& !(organizationalUnitDistinguishedNames instanceof SdkAutoConstructList);
}
/**
*
* The distinguished names of the organizational units for computer accounts.
*
*
* 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 #hasOrganizationalUnitDistinguishedNames}
* method.
*
*
* @return The distinguished names of the organizational units for computer accounts.
*/
public final List organizationalUnitDistinguishedNames() {
return organizationalUnitDistinguishedNames;
}
/**
*
* The credentials for the service account used by the fleet or image builder to connect to the directory.
*
*
* @return The credentials for the service account used by the fleet or image builder to connect to the directory.
*/
public final ServiceAccountCredentials serviceAccountCredentials() {
return serviceAccountCredentials;
}
/**
*
* The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user
* identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when
* certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain
* password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen.
* Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to
* log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
*
*
* @return The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP)
* user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default
* when certificate-based authentication is Enabled . Fallback allows users to log in using their AD
* domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen.
* Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow
* users to log in using their AD domain password. Users will be disconnected to re-authenticate using
* certificates.
*/
public final CertificateBasedAuthProperties certificateBasedAuthProperties() {
return certificateBasedAuthProperties;
}
@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(directoryName());
hashCode = 31 * hashCode
+ Objects.hashCode(hasOrganizationalUnitDistinguishedNames() ? organizationalUnitDistinguishedNames() : null);
hashCode = 31 * hashCode + Objects.hashCode(serviceAccountCredentials());
hashCode = 31 * hashCode + Objects.hashCode(certificateBasedAuthProperties());
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 UpdateDirectoryConfigRequest)) {
return false;
}
UpdateDirectoryConfigRequest other = (UpdateDirectoryConfigRequest) obj;
return Objects.equals(directoryName(), other.directoryName())
&& hasOrganizationalUnitDistinguishedNames() == other.hasOrganizationalUnitDistinguishedNames()
&& Objects.equals(organizationalUnitDistinguishedNames(), other.organizationalUnitDistinguishedNames())
&& Objects.equals(serviceAccountCredentials(), other.serviceAccountCredentials())
&& Objects.equals(certificateBasedAuthProperties(), other.certificateBasedAuthProperties());
}
/**
* 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("UpdateDirectoryConfigRequest")
.add("DirectoryName", directoryName())
.add("OrganizationalUnitDistinguishedNames",
hasOrganizationalUnitDistinguishedNames() ? organizationalUnitDistinguishedNames() : null)
.add("ServiceAccountCredentials", serviceAccountCredentials())
.add("CertificateBasedAuthProperties", certificateBasedAuthProperties()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DirectoryName":
return Optional.ofNullable(clazz.cast(directoryName()));
case "OrganizationalUnitDistinguishedNames":
return Optional.ofNullable(clazz.cast(organizationalUnitDistinguishedNames()));
case "ServiceAccountCredentials":
return Optional.ofNullable(clazz.cast(serviceAccountCredentials()));
case "CertificateBasedAuthProperties":
return Optional.ofNullable(clazz.cast(certificateBasedAuthProperties()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateDirectoryConfigRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AppStreamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the Directory Config object.
*
*
* @param directoryName
* The name of the Directory Config object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder directoryName(String directoryName);
/**
*
* The distinguished names of the organizational units for computer accounts.
*
*
* @param organizationalUnitDistinguishedNames
* The distinguished names of the organizational units for computer accounts.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder organizationalUnitDistinguishedNames(Collection organizationalUnitDistinguishedNames);
/**
*
* The distinguished names of the organizational units for computer accounts.
*
*
* @param organizationalUnitDistinguishedNames
* The distinguished names of the organizational units for computer accounts.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder organizationalUnitDistinguishedNames(String... organizationalUnitDistinguishedNames);
/**
*
* The credentials for the service account used by the fleet or image builder to connect to the directory.
*
*
* @param serviceAccountCredentials
* The credentials for the service account used by the fleet or image builder to connect to the
* directory.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder serviceAccountCredentials(ServiceAccountCredentials serviceAccountCredentials);
/**
*
* The credentials for the service account used by the fleet or image builder to connect to the directory.
*
* This is a convenience method that creates an instance of the {@link ServiceAccountCredentials.Builder}
* avoiding the need to create one manually via {@link ServiceAccountCredentials#builder()}.
*
*
* When the {@link Consumer} completes, {@link ServiceAccountCredentials.Builder#build()} is called immediately
* and its result is passed to {@link #serviceAccountCredentials(ServiceAccountCredentials)}.
*
* @param serviceAccountCredentials
* a consumer that will call methods on {@link ServiceAccountCredentials.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #serviceAccountCredentials(ServiceAccountCredentials)
*/
default Builder serviceAccountCredentials(Consumer serviceAccountCredentials) {
return serviceAccountCredentials(ServiceAccountCredentials.builder().applyMutation(serviceAccountCredentials).build());
}
/**
*
* The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user
* identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when
* certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain
* password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen.
* Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users
* to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
*
*
* @param certificateBasedAuthProperties
* The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP)
* user identities to Active Directory domain-joined streaming instances. Fallback is turned on by
* default when certificate-based authentication is Enabled . Fallback allows users to log in
* using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a
* desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based
* authentication, but does not allow users to log in using their AD domain password. Users will be
* disconnected to re-authenticate using certificates.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder certificateBasedAuthProperties(CertificateBasedAuthProperties certificateBasedAuthProperties);
/**
*
* The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user
* identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when
* certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain
* password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen.
* Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users
* to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
*
* This is a convenience method that creates an instance of the {@link CertificateBasedAuthProperties.Builder}
* avoiding the need to create one manually via {@link CertificateBasedAuthProperties#builder()}.
*
*
* When the {@link Consumer} completes, {@link CertificateBasedAuthProperties.Builder#build()} is called
* immediately and its result is passed to
* {@link #certificateBasedAuthProperties(CertificateBasedAuthProperties)}.
*
* @param certificateBasedAuthProperties
* a consumer that will call methods on {@link CertificateBasedAuthProperties.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #certificateBasedAuthProperties(CertificateBasedAuthProperties)
*/
default Builder certificateBasedAuthProperties(
Consumer certificateBasedAuthProperties) {
return certificateBasedAuthProperties(CertificateBasedAuthProperties.builder()
.applyMutation(certificateBasedAuthProperties).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends AppStreamRequest.BuilderImpl implements Builder {
private String directoryName;
private List organizationalUnitDistinguishedNames = DefaultSdkAutoConstructList.getInstance();
private ServiceAccountCredentials serviceAccountCredentials;
private CertificateBasedAuthProperties certificateBasedAuthProperties;
private BuilderImpl() {
}
private BuilderImpl(UpdateDirectoryConfigRequest model) {
super(model);
directoryName(model.directoryName);
organizationalUnitDistinguishedNames(model.organizationalUnitDistinguishedNames);
serviceAccountCredentials(model.serviceAccountCredentials);
certificateBasedAuthProperties(model.certificateBasedAuthProperties);
}
public final String getDirectoryName() {
return directoryName;
}
public final void setDirectoryName(String directoryName) {
this.directoryName = directoryName;
}
@Override
public final Builder directoryName(String directoryName) {
this.directoryName = directoryName;
return this;
}
public final Collection getOrganizationalUnitDistinguishedNames() {
if (organizationalUnitDistinguishedNames instanceof SdkAutoConstructList) {
return null;
}
return organizationalUnitDistinguishedNames;
}
public final void setOrganizationalUnitDistinguishedNames(Collection organizationalUnitDistinguishedNames) {
this.organizationalUnitDistinguishedNames = OrganizationalUnitDistinguishedNamesListCopier
.copy(organizationalUnitDistinguishedNames);
}
@Override
public final Builder organizationalUnitDistinguishedNames(Collection organizationalUnitDistinguishedNames) {
this.organizationalUnitDistinguishedNames = OrganizationalUnitDistinguishedNamesListCopier
.copy(organizationalUnitDistinguishedNames);
return this;
}
@Override
@SafeVarargs
public final Builder organizationalUnitDistinguishedNames(String... organizationalUnitDistinguishedNames) {
organizationalUnitDistinguishedNames(Arrays.asList(organizationalUnitDistinguishedNames));
return this;
}
public final ServiceAccountCredentials.Builder getServiceAccountCredentials() {
return serviceAccountCredentials != null ? serviceAccountCredentials.toBuilder() : null;
}
public final void setServiceAccountCredentials(ServiceAccountCredentials.BuilderImpl serviceAccountCredentials) {
this.serviceAccountCredentials = serviceAccountCredentials != null ? serviceAccountCredentials.build() : null;
}
@Override
public final Builder serviceAccountCredentials(ServiceAccountCredentials serviceAccountCredentials) {
this.serviceAccountCredentials = serviceAccountCredentials;
return this;
}
public final CertificateBasedAuthProperties.Builder getCertificateBasedAuthProperties() {
return certificateBasedAuthProperties != null ? certificateBasedAuthProperties.toBuilder() : null;
}
public final void setCertificateBasedAuthProperties(
CertificateBasedAuthProperties.BuilderImpl certificateBasedAuthProperties) {
this.certificateBasedAuthProperties = certificateBasedAuthProperties != null ? certificateBasedAuthProperties.build()
: null;
}
@Override
public final Builder certificateBasedAuthProperties(CertificateBasedAuthProperties certificateBasedAuthProperties) {
this.certificateBasedAuthProperties = certificateBasedAuthProperties;
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 UpdateDirectoryConfigRequest build() {
return new UpdateDirectoryConfigRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}