software.amazon.awssdk.services.batch.model.CancelJobRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of batch Show documentation
Show all versions of batch Show documentation
The AWS Java SDK for AWS Batch module holds the client classes that are used for communicating with AWS
Batch.
/*
* 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.batch.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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains the parameters for CancelJob.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CancelJobRequest extends BatchRequest implements ToCopyableBuilder {
private static final SdkField JOB_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("jobId")
.getter(getter(CancelJobRequest::jobId)).setter(setter(Builder::jobId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("jobId").build()).build();
private static final SdkField REASON_FIELD = SdkField. builder(MarshallingType.STRING).memberName("reason")
.getter(getter(CancelJobRequest::reason)).setter(setter(Builder::reason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("reason").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(JOB_ID_FIELD, REASON_FIELD));
private final String jobId;
private final String reason;
private CancelJobRequest(BuilderImpl builder) {
super(builder);
this.jobId = builder.jobId;
this.reason = builder.reason;
}
/**
*
* The AWS Batch job ID of the job to cancel.
*
*
* @return The AWS Batch job ID of the job to cancel.
*/
public final String jobId() {
return jobId;
}
/**
*
* A message to attach to the job that explains the reason for canceling it. This message is returned by future
* DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.
*
*
* @return A message to attach to the job that explains the reason for canceling it. This message is returned by
* future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity
* logs.
*/
public final String reason() {
return reason;
}
@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(jobId());
hashCode = 31 * hashCode + Objects.hashCode(reason());
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 CancelJobRequest)) {
return false;
}
CancelJobRequest other = (CancelJobRequest) obj;
return Objects.equals(jobId(), other.jobId()) && Objects.equals(reason(), other.reason());
}
/**
* 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("CancelJobRequest").add("JobId", jobId()).add("Reason", reason()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "jobId":
return Optional.ofNullable(clazz.cast(jobId()));
case "reason":
return Optional.ofNullable(clazz.cast(reason()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CancelJobRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends BatchRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The AWS Batch job ID of the job to cancel.
*
*
* @param jobId
* The AWS Batch job ID of the job to cancel.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder jobId(String jobId);
/**
*
* A message to attach to the job that explains the reason for canceling it. This message is returned by future
* DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.
*
*
* @param reason
* A message to attach to the job that explains the reason for canceling it. This message is returned by
* future DescribeJobs operations on the job. This message is also recorded in the AWS Batch
* activity logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reason(String reason);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends BatchRequest.BuilderImpl implements Builder {
private String jobId;
private String reason;
private BuilderImpl() {
}
private BuilderImpl(CancelJobRequest model) {
super(model);
jobId(model.jobId);
reason(model.reason);
}
public final String getJobId() {
return jobId;
}
@Override
public final Builder jobId(String jobId) {
this.jobId = jobId;
return this;
}
public final void setJobId(String jobId) {
this.jobId = jobId;
}
public final String getReason() {
return reason;
}
@Override
public final Builder reason(String reason) {
this.reason = reason;
return this;
}
public final void setReason(String reason) {
this.reason = reason;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CancelJobRequest build() {
return new CancelJobRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}