software.amazon.awssdk.services.s3control.model.ListJobsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of s3control Show documentation
Show all versions of s3control Show documentation
The AWS Java SDK for Amazon S3 Control module holds the client classes that are used for communicating with
Amazon Simple Storage Service Control Plane
/*
* 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.util.Arrays;
import java.util.Collection;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 ListJobsRequest extends S3ControlRequest implements
ToCopyableBuilder {
private static final SdkField ACCOUNT_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("AccountId")
.getter(getter(ListJobsRequest::accountId))
.setter(setter(Builder::accountId))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-account-id")
.unmarshallLocationName("x-amz-account-id").build()).build();
private static final SdkField> JOB_STATUSES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("JobStatuses")
.getter(getter(ListJobsRequest::jobStatusesAsStrings))
.setter(setter(Builder::jobStatusesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("jobStatuses")
.unmarshallLocationName("jobStatuses").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").unmarshallLocationName("member").build()).build())
.build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("NextToken")
.getter(getter(ListJobsRequest::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("nextToken")
.unmarshallLocationName("nextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("MaxResults")
.getter(getter(ListJobsRequest::maxResults))
.setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("maxResults")
.unmarshallLocationName("maxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ACCOUNT_ID_FIELD,
JOB_STATUSES_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final String accountId;
private final List jobStatuses;
private final String nextToken;
private final Integer maxResults;
private ListJobsRequest(BuilderImpl builder) {
super(builder);
this.accountId = builder.accountId;
this.jobStatuses = builder.jobStatuses;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
*
* The AWS account ID associated with the S3 Batch Operations job.
*
*
* @return The AWS account ID associated with the S3 Batch Operations job.
*/
public final String accountId() {
return accountId;
}
/**
*
* The List Jobs request returns jobs that match the statuses listed in this element.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasJobStatuses()} to see if a value was sent in this field.
*
*
* @return The List Jobs request returns jobs that match the statuses listed in this element.
*/
public final List jobStatuses() {
return JobStatusListCopier.copyStringToEnum(jobStatuses);
}
/**
* Returns true if the JobStatuses 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 final boolean hasJobStatuses() {
return jobStatuses != null && !(jobStatuses instanceof SdkAutoConstructList);
}
/**
*
* The List Jobs request returns jobs that match the statuses listed in this element.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasJobStatuses()} to see if a value was sent in this field.
*
*
* @return The List Jobs request returns jobs that match the statuses listed in this element.
*/
public final List jobStatusesAsStrings() {
return jobStatuses;
}
/**
*
* A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
* NextToken element of the ListJobsResult from the previous List Jobs
* request.
*
*
* @return A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
* NextToken element of the ListJobsResult from the previous
* List Jobs request.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more
* jobs than this number, the response will include a pagination token in the NextToken field to enable
* you to retrieve the next page of results.
*
*
* @return The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there
* are more jobs than this number, the response will include a pagination token in the
* NextToken field to enable you to retrieve the next page of results.
*/
public final Integer maxResults() {
return maxResults;
}
@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(accountId());
hashCode = 31 * hashCode + Objects.hashCode(hasJobStatuses() ? jobStatusesAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 ListJobsRequest)) {
return false;
}
ListJobsRequest other = (ListJobsRequest) obj;
return Objects.equals(accountId(), other.accountId()) && hasJobStatuses() == other.hasJobStatuses()
&& Objects.equals(jobStatusesAsStrings(), other.jobStatusesAsStrings())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults());
}
/**
* 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("ListJobsRequest").add("AccountId", accountId())
.add("JobStatuses", hasJobStatuses() ? jobStatusesAsStrings() : null).add("NextToken", nextToken())
.add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AccountId":
return Optional.ofNullable(clazz.cast(accountId()));
case "JobStatuses":
return Optional.ofNullable(clazz.cast(jobStatusesAsStrings()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListJobsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends S3ControlRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The AWS account ID associated with the S3 Batch Operations job.
*
*
* @param accountId
* The AWS account ID associated with the S3 Batch Operations job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder accountId(String accountId);
/**
*
* The List Jobs request returns jobs that match the statuses listed in this element.
*
*
* @param jobStatuses
* The List Jobs request returns jobs that match the statuses listed in this element.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder jobStatusesWithStrings(Collection jobStatuses);
/**
*
* The List Jobs request returns jobs that match the statuses listed in this element.
*
*
* @param jobStatuses
* The List Jobs request returns jobs that match the statuses listed in this element.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder jobStatusesWithStrings(String... jobStatuses);
/**
*
* The List Jobs request returns jobs that match the statuses listed in this element.
*
*
* @param jobStatuses
* The List Jobs request returns jobs that match the statuses listed in this element.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder jobStatuses(Collection jobStatuses);
/**
*
* The List Jobs request returns jobs that match the statuses listed in this element.
*
*
* @param jobStatuses
* The List Jobs request returns jobs that match the statuses listed in this element.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder jobStatuses(JobStatus... jobStatuses);
/**
*
* A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
* NextToken element of the ListJobsResult from the previous List Jobs
* request.
*
*
* @param nextToken
* A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
* NextToken element of the ListJobsResult from the previous
* List Jobs request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are
* more jobs than this number, the response will include a pagination token in the NextToken field
* to enable you to retrieve the next page of results.
*
*
* @param maxResults
* The maximum number of jobs that Amazon S3 will include in the List Jobs response. If
* there are more jobs than this number, the response will include a pagination token in the
* NextToken field to enable you to retrieve the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends S3ControlRequest.BuilderImpl implements Builder {
private String accountId;
private List jobStatuses = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(ListJobsRequest model) {
super(model);
accountId(model.accountId);
jobStatusesWithStrings(model.jobStatuses);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final String getAccountId() {
return accountId;
}
@Override
public final Builder accountId(String accountId) {
this.accountId = accountId;
return this;
}
public final void setAccountId(String accountId) {
this.accountId = accountId;
}
public final Collection getJobStatuses() {
if (jobStatuses instanceof SdkAutoConstructList) {
return null;
}
return jobStatuses;
}
@Override
public final Builder jobStatusesWithStrings(Collection jobStatuses) {
this.jobStatuses = JobStatusListCopier.copy(jobStatuses);
return this;
}
@Override
@SafeVarargs
public final Builder jobStatusesWithStrings(String... jobStatuses) {
jobStatusesWithStrings(Arrays.asList(jobStatuses));
return this;
}
@Override
public final Builder jobStatuses(Collection jobStatuses) {
this.jobStatuses = JobStatusListCopier.copyEnumToString(jobStatuses);
return this;
}
@Override
@SafeVarargs
public final Builder jobStatuses(JobStatus... jobStatuses) {
jobStatuses(Arrays.asList(jobStatuses));
return this;
}
public final void setJobStatuses(Collection jobStatuses) {
this.jobStatuses = JobStatusListCopier.copy(jobStatuses);
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
public final Integer getMaxResults() {
return maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListJobsRequest build() {
return new ListJobsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy