software.amazon.awssdk.services.neptunegraph.model.CreateGraphSnapshotRequest Maven / Gradle / Ivy
Show all versions of neptunegraph 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.neptunegraph.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 CreateGraphSnapshotRequest extends NeptuneGraphRequest implements
ToCopyableBuilder {
private static final SdkField GRAPH_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("graphIdentifier").getter(getter(CreateGraphSnapshotRequest::graphIdentifier))
.setter(setter(Builder::graphIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("graphIdentifier").build()).build();
private static final SdkField SNAPSHOT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("snapshotName").getter(getter(CreateGraphSnapshotRequest::snapshotName))
.setter(setter(Builder::snapshotName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("snapshotName").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(CreateGraphSnapshotRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").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(GRAPH_IDENTIFIER_FIELD,
SNAPSHOT_NAME_FIELD, TAGS_FIELD));
private final String graphIdentifier;
private final String snapshotName;
private final Map tags;
private CreateGraphSnapshotRequest(BuilderImpl builder) {
super(builder);
this.graphIdentifier = builder.graphIdentifier;
this.snapshotName = builder.snapshotName;
this.tags = builder.tags;
}
/**
*
* The unique identifier of the Neptune Analytics graph.
*
*
* @return The unique identifier of the Neptune Analytics graph.
*/
public final String graphIdentifier() {
return graphIdentifier;
}
/**
*
* The snapshot name. For example: my-snapshot-1.
*
*
* The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It
* cannot end with a hyphen or contain two consecutive hyphens.
*
*
* @return The snapshot name. For example: my-snapshot-1.
*
* The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a
* letter. It cannot end with a hyphen or contain two consecutive hyphens.
*/
public final String snapshotName() {
return snapshotName;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a
* Condition statement in an IAM policy.
*
*
* 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 #hasTags} method.
*
*
* @return Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used
* in a Condition statement in an IAM policy.
*/
public final Map tags() {
return tags;
}
@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(graphIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(snapshotName());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : 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 CreateGraphSnapshotRequest)) {
return false;
}
CreateGraphSnapshotRequest other = (CreateGraphSnapshotRequest) obj;
return Objects.equals(graphIdentifier(), other.graphIdentifier()) && Objects.equals(snapshotName(), other.snapshotName())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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("CreateGraphSnapshotRequest").add("GraphIdentifier", graphIdentifier())
.add("SnapshotName", snapshotName()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "graphIdentifier":
return Optional.ofNullable(clazz.cast(graphIdentifier()));
case "snapshotName":
return Optional.ofNullable(clazz.cast(snapshotName()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateGraphSnapshotRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends NeptuneGraphRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The unique identifier of the Neptune Analytics graph.
*
*
* @param graphIdentifier
* The unique identifier of the Neptune Analytics graph.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder graphIdentifier(String graphIdentifier);
/**
*
* The snapshot name. For example: my-snapshot-1.
*
*
* The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It
* cannot end with a hyphen or contain two consecutive hyphens.
*
*
* @param snapshotName
* The snapshot name. For example: my-snapshot-1.
*
* The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a
* letter. It cannot end with a hyphen or contain two consecutive hyphens.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder snapshotName(String snapshotName);
/**
*
* Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a
* Condition statement in an IAM policy.
*
*
* @param tags
* Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or
* used in a Condition statement in an IAM policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends NeptuneGraphRequest.BuilderImpl implements Builder {
private String graphIdentifier;
private String snapshotName;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateGraphSnapshotRequest model) {
super(model);
graphIdentifier(model.graphIdentifier);
snapshotName(model.snapshotName);
tags(model.tags);
}
public final String getGraphIdentifier() {
return graphIdentifier;
}
public final void setGraphIdentifier(String graphIdentifier) {
this.graphIdentifier = graphIdentifier;
}
@Override
public final Builder graphIdentifier(String graphIdentifier) {
this.graphIdentifier = graphIdentifier;
return this;
}
public final String getSnapshotName() {
return snapshotName;
}
public final void setSnapshotName(String snapshotName) {
this.snapshotName = snapshotName;
}
@Override
public final Builder snapshotName(String snapshotName) {
this.snapshotName = snapshotName;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
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 CreateGraphSnapshotRequest build() {
return new CreateGraphSnapshotRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}