software.amazon.awssdk.services.transfer.model.DeleteAccessRequest Maven / Gradle / Ivy
Show all versions of transfer 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.transfer.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DeleteAccessRequest extends TransferRequest implements
ToCopyableBuilder {
private static final SdkField SERVER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ServerId").getter(getter(DeleteAccessRequest::serverId)).setter(setter(Builder::serverId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServerId").build()).build();
private static final SdkField EXTERNAL_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExternalId").getter(getter(DeleteAccessRequest::externalId)).setter(setter(Builder::externalId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExternalId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SERVER_ID_FIELD,
EXTERNAL_ID_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String serverId;
private final String externalId;
private DeleteAccessRequest(BuilderImpl builder) {
super(builder);
this.serverId = builder.serverId;
this.externalId = builder.externalId;
}
/**
*
* A system-assigned unique identifier for a server that has this user assigned.
*
*
* @return A system-assigned unique identifier for a server that has this user assigned.
*/
public final String serverId() {
return serverId;
}
/**
*
* A unique identifier that is required to identify specific groups within your directory. The users of the group
* that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using
* Transfer Family. If you know the group name, you can view the SID values by running the following command using
* Windows PowerShell.
*
*
* Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid
*
*
* In that command, replace YourGroupName with the name of your Active Directory group.
*
*
* The regular expression used to validate this parameter is a string of characters consisting of uppercase and
* lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following
* characters: =,.@:/-
*
*
* @return A unique identifier that is required to identify specific groups within your directory. The users of the
* group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols
* using Transfer Family. If you know the group name, you can view the SID values by running the following
* command using Windows PowerShell.
*
* Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid
*
*
* In that command, replace YourGroupName with the name of your Active Directory group.
*
*
* The regular expression used to validate this parameter is a string of characters consisting of uppercase
* and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the
* following characters: =,.@:/-
*/
public final String externalId() {
return externalId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(serverId());
hashCode = 31 * hashCode + Objects.hashCode(externalId());
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 DeleteAccessRequest)) {
return false;
}
DeleteAccessRequest other = (DeleteAccessRequest) obj;
return Objects.equals(serverId(), other.serverId()) && Objects.equals(externalId(), other.externalId());
}
/**
* 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("DeleteAccessRequest").add("ServerId", serverId()).add("ExternalId", externalId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ServerId":
return Optional.ofNullable(clazz.cast(serverId()));
case "ExternalId":
return Optional.ofNullable(clazz.cast(externalId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("ServerId", SERVER_ID_FIELD);
map.put("ExternalId", EXTERNAL_ID_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function
*
* Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid
*
*
* In that command, replace YourGroupName with the name of your Active Directory group.
*
*
* The regular expression used to validate this parameter is a string of characters consisting of
* uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or
* any of the following characters: =,.@:/-
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder externalId(String externalId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends TransferRequest.BuilderImpl implements Builder {
private String serverId;
private String externalId;
private BuilderImpl() {
}
private BuilderImpl(DeleteAccessRequest model) {
super(model);
serverId(model.serverId);
externalId(model.externalId);
}
public final String getServerId() {
return serverId;
}
public final void setServerId(String serverId) {
this.serverId = serverId;
}
@Override
public final Builder serverId(String serverId) {
this.serverId = serverId;
return this;
}
public final String getExternalId() {
return externalId;
}
public final void setExternalId(String externalId) {
this.externalId = externalId;
}
@Override
public final Builder externalId(String externalId) {
this.externalId = externalId;
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 DeleteAccessRequest build() {
return new DeleteAccessRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}