software.amazon.awssdk.services.deadline.model.UpdateStorageProfileRequest Maven / Gradle / Ivy
Show all versions of deadline 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.deadline.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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.DefaultValueTrait;
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 UpdateStorageProfileRequest extends DeadlineRequest implements
ToCopyableBuilder {
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(UpdateStorageProfileRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("X-Amz-Client-Token").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField FARM_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("farmId")
.getter(getter(UpdateStorageProfileRequest::farmId)).setter(setter(Builder::farmId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("farmId").build()).build();
private static final SdkField STORAGE_PROFILE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("storageProfileId").getter(getter(UpdateStorageProfileRequest::storageProfileId))
.setter(setter(Builder::storageProfileId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("storageProfileId").build()).build();
private static final SdkField DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("displayName").getter(getter(UpdateStorageProfileRequest::displayName))
.setter(setter(Builder::displayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("displayName").build()).build();
private static final SdkField OS_FAMILY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("osFamily").getter(getter(UpdateStorageProfileRequest::osFamilyAsString))
.setter(setter(Builder::osFamily))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("osFamily").build()).build();
private static final SdkField> FILE_SYSTEM_LOCATIONS_TO_ADD_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("fileSystemLocationsToAdd")
.getter(getter(UpdateStorageProfileRequest::fileSystemLocationsToAdd))
.setter(setter(Builder::fileSystemLocationsToAdd))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("fileSystemLocationsToAdd").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(FileSystemLocation::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> FILE_SYSTEM_LOCATIONS_TO_REMOVE_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("fileSystemLocationsToRemove")
.getter(getter(UpdateStorageProfileRequest::fileSystemLocationsToRemove))
.setter(setter(Builder::fileSystemLocationsToRemove))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("fileSystemLocationsToRemove")
.build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(FileSystemLocation::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLIENT_TOKEN_FIELD,
FARM_ID_FIELD, STORAGE_PROFILE_ID_FIELD, DISPLAY_NAME_FIELD, OS_FAMILY_FIELD, FILE_SYSTEM_LOCATIONS_TO_ADD_FIELD,
FILE_SYSTEM_LOCATIONS_TO_REMOVE_FIELD));
private final String clientToken;
private final String farmId;
private final String storageProfileId;
private final String displayName;
private final String osFamily;
private final List fileSystemLocationsToAdd;
private final List fileSystemLocationsToRemove;
private UpdateStorageProfileRequest(BuilderImpl builder) {
super(builder);
this.clientToken = builder.clientToken;
this.farmId = builder.farmId;
this.storageProfileId = builder.storageProfileId;
this.displayName = builder.displayName;
this.osFamily = builder.osFamily;
this.fileSystemLocationsToAdd = builder.fileSystemLocationsToAdd;
this.fileSystemLocationsToRemove = builder.fileSystemLocationsToRemove;
}
/**
*
* The unique token which the server uses to recognize retries of the same request.
*
*
* @return The unique token which the server uses to recognize retries of the same request.
*/
public final String clientToken() {
return clientToken;
}
/**
*
* The farm ID to update.
*
*
* @return The farm ID to update.
*/
public final String farmId() {
return farmId;
}
/**
*
* The storage profile ID to update.
*
*
* @return The storage profile ID to update.
*/
public final String storageProfileId() {
return storageProfileId;
}
/**
*
* The display name of the storage profile to update.
*
*
*
* This field can store any content. Escape or encode this content before displaying it on a webpage or any other
* system that might interpret the content of this field.
*
*
*
* @return The display name of the storage profile to update.
*
* This field can store any content. Escape or encode this content before displaying it on a webpage or any
* other system that might interpret the content of this field.
*
*/
public final String displayName() {
return displayName;
}
/**
*
* The OS system to update.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #osFamily} will
* return {@link StorageProfileOperatingSystemFamily#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service
* is available from {@link #osFamilyAsString}.
*
*
* @return The OS system to update.
* @see StorageProfileOperatingSystemFamily
*/
public final StorageProfileOperatingSystemFamily osFamily() {
return StorageProfileOperatingSystemFamily.fromValue(osFamily);
}
/**
*
* The OS system to update.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #osFamily} will
* return {@link StorageProfileOperatingSystemFamily#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service
* is available from {@link #osFamilyAsString}.
*
*
* @return The OS system to update.
* @see StorageProfileOperatingSystemFamily
*/
public final String osFamilyAsString() {
return osFamily;
}
/**
* For responses, this returns true if the service returned a value for the FileSystemLocationsToAdd 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 hasFileSystemLocationsToAdd() {
return fileSystemLocationsToAdd != null && !(fileSystemLocationsToAdd instanceof SdkAutoConstructList);
}
/**
*
* The file system location names to add.
*
*
* 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 #hasFileSystemLocationsToAdd} method.
*
*
* @return The file system location names to add.
*/
public final List fileSystemLocationsToAdd() {
return fileSystemLocationsToAdd;
}
/**
* For responses, this returns true if the service returned a value for the FileSystemLocationsToRemove 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 hasFileSystemLocationsToRemove() {
return fileSystemLocationsToRemove != null && !(fileSystemLocationsToRemove instanceof SdkAutoConstructList);
}
/**
*
* The file system location names to remove.
*
*
* 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 #hasFileSystemLocationsToRemove} method.
*
*
* @return The file system location names to remove.
*/
public final List fileSystemLocationsToRemove() {
return fileSystemLocationsToRemove;
}
@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(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(farmId());
hashCode = 31 * hashCode + Objects.hashCode(storageProfileId());
hashCode = 31 * hashCode + Objects.hashCode(displayName());
hashCode = 31 * hashCode + Objects.hashCode(osFamilyAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasFileSystemLocationsToAdd() ? fileSystemLocationsToAdd() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasFileSystemLocationsToRemove() ? fileSystemLocationsToRemove() : 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 UpdateStorageProfileRequest)) {
return false;
}
UpdateStorageProfileRequest other = (UpdateStorageProfileRequest) obj;
return Objects.equals(clientToken(), other.clientToken()) && Objects.equals(farmId(), other.farmId())
&& Objects.equals(storageProfileId(), other.storageProfileId())
&& Objects.equals(displayName(), other.displayName())
&& Objects.equals(osFamilyAsString(), other.osFamilyAsString())
&& hasFileSystemLocationsToAdd() == other.hasFileSystemLocationsToAdd()
&& Objects.equals(fileSystemLocationsToAdd(), other.fileSystemLocationsToAdd())
&& hasFileSystemLocationsToRemove() == other.hasFileSystemLocationsToRemove()
&& Objects.equals(fileSystemLocationsToRemove(), other.fileSystemLocationsToRemove());
}
/**
* 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("UpdateStorageProfileRequest")
.add("ClientToken", clientToken())
.add("FarmId", farmId())
.add("StorageProfileId", storageProfileId())
.add("DisplayName", displayName())
.add("OsFamily", osFamilyAsString())
.add("FileSystemLocationsToAdd", fileSystemLocationsToAdd() == null ? null : "*** Sensitive Data Redacted ***")
.add("FileSystemLocationsToRemove",
fileSystemLocationsToRemove() == null ? null : "*** Sensitive Data Redacted ***").build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "farmId":
return Optional.ofNullable(clazz.cast(farmId()));
case "storageProfileId":
return Optional.ofNullable(clazz.cast(storageProfileId()));
case "displayName":
return Optional.ofNullable(clazz.cast(displayName()));
case "osFamily":
return Optional.ofNullable(clazz.cast(osFamilyAsString()));
case "fileSystemLocationsToAdd":
return Optional.ofNullable(clazz.cast(fileSystemLocationsToAdd()));
case "fileSystemLocationsToRemove":
return Optional.ofNullable(clazz.cast(fileSystemLocationsToRemove()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateStorageProfileRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DeadlineRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The unique token which the server uses to recognize retries of the same request.
*
*
* @param clientToken
* The unique token which the server uses to recognize retries of the same request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
/**
*
* The farm ID to update.
*
*
* @param farmId
* The farm ID to update.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder farmId(String farmId);
/**
*
* The storage profile ID to update.
*
*
* @param storageProfileId
* The storage profile ID to update.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder storageProfileId(String storageProfileId);
/**
*
* The display name of the storage profile to update.
*
*
*
* This field can store any content. Escape or encode this content before displaying it on a webpage or any
* other system that might interpret the content of this field.
*
*
*
* @param displayName
* The display name of the storage profile to update.
*
* This field can store any content. Escape or encode this content before displaying it on a webpage or
* any other system that might interpret the content of this field.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder displayName(String displayName);
/**
*
* The OS system to update.
*
*
* @param osFamily
* The OS system to update.
* @see StorageProfileOperatingSystemFamily
* @return Returns a reference to this object so that method calls can be chained together.
* @see StorageProfileOperatingSystemFamily
*/
Builder osFamily(String osFamily);
/**
*
* The OS system to update.
*
*
* @param osFamily
* The OS system to update.
* @see StorageProfileOperatingSystemFamily
* @return Returns a reference to this object so that method calls can be chained together.
* @see StorageProfileOperatingSystemFamily
*/
Builder osFamily(StorageProfileOperatingSystemFamily osFamily);
/**
*
* The file system location names to add.
*
*
* @param fileSystemLocationsToAdd
* The file system location names to add.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fileSystemLocationsToAdd(Collection fileSystemLocationsToAdd);
/**
*
* The file system location names to add.
*
*
* @param fileSystemLocationsToAdd
* The file system location names to add.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fileSystemLocationsToAdd(FileSystemLocation... fileSystemLocationsToAdd);
/**
*
* The file system location names to add.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.deadline.model.FileSystemLocation.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.deadline.model.FileSystemLocation#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.deadline.model.FileSystemLocation.Builder#build()} is called
* immediately and its result is passed to {@link #fileSystemLocationsToAdd(List)}.
*
* @param fileSystemLocationsToAdd
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.deadline.model.FileSystemLocation.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #fileSystemLocationsToAdd(java.util.Collection)
*/
Builder fileSystemLocationsToAdd(Consumer... fileSystemLocationsToAdd);
/**
*
* The file system location names to remove.
*
*
* @param fileSystemLocationsToRemove
* The file system location names to remove.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fileSystemLocationsToRemove(Collection fileSystemLocationsToRemove);
/**
*
* The file system location names to remove.
*
*
* @param fileSystemLocationsToRemove
* The file system location names to remove.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fileSystemLocationsToRemove(FileSystemLocation... fileSystemLocationsToRemove);
/**
*
* The file system location names to remove.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.deadline.model.FileSystemLocation.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.deadline.model.FileSystemLocation#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.deadline.model.FileSystemLocation.Builder#build()} is called
* immediately and its result is passed to {@link #fileSystemLocationsToRemove(List)}.
*
* @param fileSystemLocationsToRemove
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.deadline.model.FileSystemLocation.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #fileSystemLocationsToRemove(java.util.Collection)
*/
Builder fileSystemLocationsToRemove(Consumer... fileSystemLocationsToRemove);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends DeadlineRequest.BuilderImpl implements Builder {
private String clientToken;
private String farmId;
private String storageProfileId;
private String displayName;
private String osFamily;
private List fileSystemLocationsToAdd = DefaultSdkAutoConstructList.getInstance();
private List fileSystemLocationsToRemove = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(UpdateStorageProfileRequest model) {
super(model);
clientToken(model.clientToken);
farmId(model.farmId);
storageProfileId(model.storageProfileId);
displayName(model.displayName);
osFamily(model.osFamily);
fileSystemLocationsToAdd(model.fileSystemLocationsToAdd);
fileSystemLocationsToRemove(model.fileSystemLocationsToRemove);
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
public final String getFarmId() {
return farmId;
}
public final void setFarmId(String farmId) {
this.farmId = farmId;
}
@Override
public final Builder farmId(String farmId) {
this.farmId = farmId;
return this;
}
public final String getStorageProfileId() {
return storageProfileId;
}
public final void setStorageProfileId(String storageProfileId) {
this.storageProfileId = storageProfileId;
}
@Override
public final Builder storageProfileId(String storageProfileId) {
this.storageProfileId = storageProfileId;
return this;
}
public final String getDisplayName() {
return displayName;
}
public final void setDisplayName(String displayName) {
this.displayName = displayName;
}
@Override
public final Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
public final String getOsFamily() {
return osFamily;
}
public final void setOsFamily(String osFamily) {
this.osFamily = osFamily;
}
@Override
public final Builder osFamily(String osFamily) {
this.osFamily = osFamily;
return this;
}
@Override
public final Builder osFamily(StorageProfileOperatingSystemFamily osFamily) {
this.osFamily(osFamily == null ? null : osFamily.toString());
return this;
}
public final List getFileSystemLocationsToAdd() {
List result = FileSystemLocationsListCopier.copyToBuilder(this.fileSystemLocationsToAdd);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFileSystemLocationsToAdd(Collection fileSystemLocationsToAdd) {
this.fileSystemLocationsToAdd = FileSystemLocationsListCopier.copyFromBuilder(fileSystemLocationsToAdd);
}
@Override
public final Builder fileSystemLocationsToAdd(Collection fileSystemLocationsToAdd) {
this.fileSystemLocationsToAdd = FileSystemLocationsListCopier.copy(fileSystemLocationsToAdd);
return this;
}
@Override
@SafeVarargs
public final Builder fileSystemLocationsToAdd(FileSystemLocation... fileSystemLocationsToAdd) {
fileSystemLocationsToAdd(Arrays.asList(fileSystemLocationsToAdd));
return this;
}
@Override
@SafeVarargs
public final Builder fileSystemLocationsToAdd(Consumer... fileSystemLocationsToAdd) {
fileSystemLocationsToAdd(Stream.of(fileSystemLocationsToAdd)
.map(c -> FileSystemLocation.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getFileSystemLocationsToRemove() {
List result = FileSystemLocationsListCopier
.copyToBuilder(this.fileSystemLocationsToRemove);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFileSystemLocationsToRemove(Collection fileSystemLocationsToRemove) {
this.fileSystemLocationsToRemove = FileSystemLocationsListCopier.copyFromBuilder(fileSystemLocationsToRemove);
}
@Override
public final Builder fileSystemLocationsToRemove(Collection fileSystemLocationsToRemove) {
this.fileSystemLocationsToRemove = FileSystemLocationsListCopier.copy(fileSystemLocationsToRemove);
return this;
}
@Override
@SafeVarargs
public final Builder fileSystemLocationsToRemove(FileSystemLocation... fileSystemLocationsToRemove) {
fileSystemLocationsToRemove(Arrays.asList(fileSystemLocationsToRemove));
return this;
}
@Override
@SafeVarargs
public final Builder fileSystemLocationsToRemove(Consumer... fileSystemLocationsToRemove) {
fileSystemLocationsToRemove(Stream.of(fileSystemLocationsToRemove)
.map(c -> FileSystemLocation.builder().applyMutation(c).build()).collect(Collectors.toList()));
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 UpdateStorageProfileRequest build() {
return new UpdateStorageProfileRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}