software.amazon.awssdk.services.workdocs.model.CreateCustomMetadataRequest Maven / Gradle / Ivy
/*
* 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.workdocs.model;
import java.util.Arrays;
import java.util.Collections;
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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
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 CreateCustomMetadataRequest extends WorkDocsRequest implements
ToCopyableBuilder {
private static final SdkField AUTHENTICATION_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateCustomMetadataRequest::authenticationToken)).setter(setter(Builder::authenticationToken))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Authentication").build()).build();
private static final SdkField RESOURCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateCustomMetadataRequest::resourceId)).setter(setter(Builder::resourceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("ResourceId").build()).build();
private static final SdkField VERSION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateCustomMetadataRequest::versionId)).setter(setter(Builder::versionId))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("versionid").build()).build();
private static final SdkField> CUSTOM_METADATA_FIELD = SdkField
.> builder(MarshallingType.MAP)
.getter(getter(CreateCustomMetadataRequest::customMetadata))
.setter(setter(Builder::customMetadata))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomMetadata").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AUTHENTICATION_TOKEN_FIELD,
RESOURCE_ID_FIELD, VERSION_ID_FIELD, CUSTOM_METADATA_FIELD));
private final String authenticationToken;
private final String resourceId;
private final String versionId;
private final Map customMetadata;
private CreateCustomMetadataRequest(BuilderImpl builder) {
super(builder);
this.authenticationToken = builder.authenticationToken;
this.resourceId = builder.resourceId;
this.versionId = builder.versionId;
this.customMetadata = builder.customMetadata;
}
/**
*
* Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
*
*
* @return Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the
* API.
*/
public String authenticationToken() {
return authenticationToken;
}
/**
*
* The ID of the resource.
*
*
* @return The ID of the resource.
*/
public String resourceId() {
return resourceId;
}
/**
*
* The ID of the version, if the custom metadata is being added to a document version.
*
*
* @return The ID of the version, if the custom metadata is being added to a document version.
*/
public String versionId() {
return versionId;
}
/**
* Returns true if the CustomMetadata property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasCustomMetadata() {
return customMetadata != null && !(customMetadata instanceof SdkAutoConstructMap);
}
/**
*
* Custom metadata in the form of name-value pairs.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasCustomMetadata()} to see if a value was sent in this field.
*
*
* @return Custom metadata in the form of name-value pairs.
*/
public Map customMetadata() {
return customMetadata;
}
@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(authenticationToken());
hashCode = 31 * hashCode + Objects.hashCode(resourceId());
hashCode = 31 * hashCode + Objects.hashCode(versionId());
hashCode = 31 * hashCode + Objects.hashCode(customMetadata());
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 CreateCustomMetadataRequest)) {
return false;
}
CreateCustomMetadataRequest other = (CreateCustomMetadataRequest) obj;
return Objects.equals(authenticationToken(), other.authenticationToken())
&& Objects.equals(resourceId(), other.resourceId()) && Objects.equals(versionId(), other.versionId())
&& Objects.equals(customMetadata(), other.customMetadata());
}
/**
* 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("CreateCustomMetadataRequest")
.add("AuthenticationToken", authenticationToken() == null ? null : "*** Sensitive Data Redacted ***")
.add("ResourceId", resourceId()).add("VersionId", versionId()).add("CustomMetadata", customMetadata()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AuthenticationToken":
return Optional.ofNullable(clazz.cast(authenticationToken()));
case "ResourceId":
return Optional.ofNullable(clazz.cast(resourceId()));
case "VersionId":
return Optional.ofNullable(clazz.cast(versionId()));
case "CustomMetadata":
return Optional.ofNullable(clazz.cast(customMetadata()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateCustomMetadataRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WorkDocsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the
* API.
*
*
* @param authenticationToken
* Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access
* the API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder authenticationToken(String authenticationToken);
/**
*
* The ID of the resource.
*
*
* @param resourceId
* The ID of the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceId(String resourceId);
/**
*
* The ID of the version, if the custom metadata is being added to a document version.
*
*
* @param versionId
* The ID of the version, if the custom metadata is being added to a document version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder versionId(String versionId);
/**
*
* Custom metadata in the form of name-value pairs.
*
*
* @param customMetadata
* Custom metadata in the form of name-value pairs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customMetadata(Map customMetadata);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WorkDocsRequest.BuilderImpl implements Builder {
private String authenticationToken;
private String resourceId;
private String versionId;
private Map customMetadata = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateCustomMetadataRequest model) {
super(model);
authenticationToken(model.authenticationToken);
resourceId(model.resourceId);
versionId(model.versionId);
customMetadata(model.customMetadata);
}
public final String getAuthenticationToken() {
return authenticationToken;
}
@Override
public final Builder authenticationToken(String authenticationToken) {
this.authenticationToken = authenticationToken;
return this;
}
public final void setAuthenticationToken(String authenticationToken) {
this.authenticationToken = authenticationToken;
}
public final String getResourceId() {
return resourceId;
}
@Override
public final Builder resourceId(String resourceId) {
this.resourceId = resourceId;
return this;
}
public final void setResourceId(String resourceId) {
this.resourceId = resourceId;
}
public final String getVersionId() {
return versionId;
}
@Override
public final Builder versionId(String versionId) {
this.versionId = versionId;
return this;
}
public final void setVersionId(String versionId) {
this.versionId = versionId;
}
public final Map getCustomMetadata() {
return customMetadata;
}
@Override
public final Builder customMetadata(Map customMetadata) {
this.customMetadata = CustomMetadataMapCopier.copy(customMetadata);
return this;
}
public final void setCustomMetadata(Map customMetadata) {
this.customMetadata = CustomMetadataMapCopier.copy(customMetadata);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateCustomMetadataRequest build() {
return new CreateCustomMetadataRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy