software.amazon.awssdk.services.lookoutvision.model.StopModelRequest Maven / Gradle / Ivy
Show all versions of lookoutvision 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.lookoutvision.model;
import java.util.Arrays;
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 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.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 StopModelRequest extends LookoutVisionRequest implements
ToCopyableBuilder {
private static final SdkField PROJECT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ProjectName").getter(getter(StopModelRequest::projectName)).setter(setter(Builder::projectName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("projectName").build()).build();
private static final SdkField MODEL_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ModelVersion").getter(getter(StopModelRequest::modelVersion)).setter(setter(Builder::modelVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("modelVersion").build()).build();
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ClientToken")
.getter(getter(StopModelRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("X-Amzn-Client-Token").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PROJECT_NAME_FIELD,
MODEL_VERSION_FIELD, CLIENT_TOKEN_FIELD));
private final String projectName;
private final String modelVersion;
private final String clientToken;
private StopModelRequest(BuilderImpl builder) {
super(builder);
this.projectName = builder.projectName;
this.modelVersion = builder.modelVersion;
this.clientToken = builder.clientToken;
}
/**
*
* The name of the project that contains the model that you want to stop.
*
*
* @return The name of the project that contains the model that you want to stop.
*/
public final String projectName() {
return projectName;
}
/**
*
* The version of the model that you want to stop.
*
*
* @return The version of the model that you want to stop.
*/
public final String modelVersion() {
return modelVersion;
}
/**
*
* ClientToken is an idempotency token that ensures a call to StopModel
completes only once. You choose
* the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response
* from StopModel
. In this case, safely retry your call to StopModel
by using the same
* ClientToken
parameter value. An error occurs if the other input parameters are not the same as in
* the first request. Using a different value for ClientToken
is considered a new call to
* StopModel
. An idempotency token is active for 8 hours.
*
*
* @return ClientToken is an idempotency token that ensures a call to StopModel
completes only once.
* You choose the value to pass. For example, An issue, such as an network outage, might prevent you from
* getting a response from StopModel
. In this case, safely retry your call to
* StopModel
by using the same ClientToken
parameter value. An error occurs if the
* other input parameters are not the same as in the first request. Using a different value for
* ClientToken
is considered a new call to StopModel
. An idempotency token is
* active for 8 hours.
*/
public final String clientToken() {
return clientToken;
}
@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(projectName());
hashCode = 31 * hashCode + Objects.hashCode(modelVersion());
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
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 StopModelRequest)) {
return false;
}
StopModelRequest other = (StopModelRequest) obj;
return Objects.equals(projectName(), other.projectName()) && Objects.equals(modelVersion(), other.modelVersion())
&& Objects.equals(clientToken(), other.clientToken());
}
/**
* 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("StopModelRequest").add("ProjectName", projectName()).add("ModelVersion", modelVersion())
.add("ClientToken", clientToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ProjectName":
return Optional.ofNullable(clazz.cast(projectName()));
case "ModelVersion":
return Optional.ofNullable(clazz.cast(modelVersion()));
case "ClientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function