software.amazon.awssdk.services.s3control.model.JobManifestLocation Maven / Gradle / Ivy
Show all versions of s3control 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.s3control.model;
import java.io.Serializable;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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;
/**
*
* Contains the information required to locate a manifest object. Manifests can't be imported from directory buckets.
* For more information, see Directory buckets.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class JobManifestLocation implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField OBJECT_ARN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ObjectArn")
.getter(getter(JobManifestLocation::objectArn))
.setter(setter(Builder::objectArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ObjectArn")
.unmarshallLocationName("ObjectArn").build()).build();
private static final SdkField OBJECT_VERSION_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ObjectVersionId")
.getter(getter(JobManifestLocation::objectVersionId))
.setter(setter(Builder::objectVersionId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ObjectVersionId")
.unmarshallLocationName("ObjectVersionId").build()).build();
private static final SdkField E_TAG_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ETag")
.getter(getter(JobManifestLocation::eTag))
.setter(setter(Builder::eTag))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ETag")
.unmarshallLocationName("ETag").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OBJECT_ARN_FIELD,
OBJECT_VERSION_ID_FIELD, E_TAG_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String objectArn;
private final String objectVersionId;
private final String eTag;
private JobManifestLocation(BuilderImpl builder) {
this.objectArn = builder.objectArn;
this.objectVersionId = builder.objectVersionId;
this.eTag = builder.eTag;
}
/**
*
* The Amazon Resource Name (ARN) for a manifest object.
*
*
*
* When you're using XML requests, you must replace special characters (such as carriage returns) in object keys
* with their equivalent XML entity codes. For more information, see
* XML-related object key constraints in the Amazon S3 User Guide.
*
*
*
* @return The Amazon Resource Name (ARN) for a manifest object.
*
* When you're using XML requests, you must replace special characters (such as carriage returns) in object
* keys with their equivalent XML entity codes. For more information, see XML-related object key constraints in the Amazon S3 User Guide.
*
*/
public final String objectArn() {
return objectArn;
}
/**
*
* The optional version ID to identify a specific version of the manifest object.
*
*
* @return The optional version ID to identify a specific version of the manifest object.
*/
public final String objectVersionId() {
return objectVersionId;
}
/**
*
* The ETag for the specified manifest object.
*
*
* @return The ETag for the specified manifest object.
*/
public final String eTag() {
return eTag;
}
@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 + Objects.hashCode(objectArn());
hashCode = 31 * hashCode + Objects.hashCode(objectVersionId());
hashCode = 31 * hashCode + Objects.hashCode(eTag());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof JobManifestLocation)) {
return false;
}
JobManifestLocation other = (JobManifestLocation) obj;
return Objects.equals(objectArn(), other.objectArn()) && Objects.equals(objectVersionId(), other.objectVersionId())
&& Objects.equals(eTag(), other.eTag());
}
/**
* 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("JobManifestLocation").add("ObjectArn", objectArn()).add("ObjectVersionId", objectVersionId())
.add("ETag", eTag()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ObjectArn":
return Optional.ofNullable(clazz.cast(objectArn()));
case "ObjectVersionId":
return Optional.ofNullable(clazz.cast(objectVersionId()));
case "ETag":
return Optional.ofNullable(clazz.cast(eTag()));
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("ObjectArn", OBJECT_ARN_FIELD);
map.put("ObjectVersionId", OBJECT_VERSION_ID_FIELD);
map.put("ETag", E_TAG_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function