software.amazon.awssdk.services.mediaconvert.model.ListJobsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mediaconvert Show documentation
Show all versions of mediaconvert Show documentation
The AWS Java SDK for AWS Elemental MediaConvert module holds the client classes that are used for
communicating
with AWS Elemental MediaConvert Service
/*
* 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.mediaconvert.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListJobsRequest extends MediaConvertRequest implements
ToCopyableBuilder {
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").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").build()).build();
private static final SdkField ORDER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Order")
.getter(getter(ListJobsRequest::orderAsString)).setter(setter(Builder::order))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("order").build()).build();
private static final SdkField QUEUE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Queue")
.getter(getter(ListJobsRequest::queue)).setter(setter(Builder::queue))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("queue").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(ListJobsRequest::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("status").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MAX_RESULTS_FIELD,
NEXT_TOKEN_FIELD, ORDER_FIELD, QUEUE_FIELD, STATUS_FIELD));
private final Integer maxResults;
private final String nextToken;
private final String order;
private final String queue;
private final String status;
private ListJobsRequest(BuilderImpl builder) {
super(builder);
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.order = builder.order;
this.queue = builder.queue;
this.status = builder.status;
}
/**
* Optional. Number of jobs, up to twenty, that will be returned at one time.
*
* @return Optional. Number of jobs, up to twenty, that will be returned at one time.
*/
public final Integer maxResults() {
return maxResults;
}
/**
* Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.
*
* @return Optional. Use this string, provided with the response to a previous request, to request the next batch of
* jobs.
*/
public final String nextToken() {
return nextToken;
}
/**
* Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING
* order. Default varies by resource.
*
* If the service returns an enum value that is not available in the current SDK version, {@link #order} will return
* {@link Order#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #orderAsString}.
*
*
* @return Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or
* DESCENDING order. Default varies by resource.
* @see Order
*/
public final Order order() {
return Order.fromValue(order);
}
/**
* Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING
* order. Default varies by resource.
*
* If the service returns an enum value that is not available in the current SDK version, {@link #order} will return
* {@link Order#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #orderAsString}.
*
*
* @return Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or
* DESCENDING order. Default varies by resource.
* @see Order
*/
public final String orderAsString() {
return order;
}
/**
* Optional. Provide a queue name to get back only jobs from that queue.
*
* @return Optional. Provide a queue name to get back only jobs from that queue.
*/
public final String queue() {
return queue;
}
/**
* Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link JobStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
* @see JobStatus
*/
public final JobStatus status() {
return JobStatus.fromValue(status);
}
/**
* Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link JobStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
* @see JobStatus
*/
public final String statusAsString() {
return status;
}
@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(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(orderAsString());
hashCode = 31 * hashCode + Objects.hashCode(queue());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
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(maxResults(), other.maxResults()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(orderAsString(), other.orderAsString()) && Objects.equals(queue(), other.queue())
&& Objects.equals(statusAsString(), other.statusAsString());
}
/**
* 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("MaxResults", maxResults()).add("NextToken", nextToken())
.add("Order", orderAsString()).add("Queue", queue()).add("Status", statusAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "Order":
return Optional.ofNullable(clazz.cast(orderAsString()));
case "Queue":
return Optional.ofNullable(clazz.cast(queue()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
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 MediaConvertRequest.Builder, SdkPojo, CopyableBuilder {
/**
* Optional. Number of jobs, up to twenty, that will be returned at one time.
*
* @param maxResults
* Optional. Number of jobs, up to twenty, that will be returned at one time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
* Optional. Use this string, provided with the response to a previous request, to request the next batch of
* jobs.
*
* @param nextToken
* Optional. Use this string, provided with the response to a previous request, to request the next batch
* of jobs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
* Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or
* DESCENDING order. Default varies by resource.
*
* @param order
* Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or
* DESCENDING order. Default varies by resource.
* @see Order
* @return Returns a reference to this object so that method calls can be chained together.
* @see Order
*/
Builder order(String order);
/**
* Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or
* DESCENDING order. Default varies by resource.
*
* @param order
* Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or
* DESCENDING order. Default varies by resource.
* @see Order
* @return Returns a reference to this object so that method calls can be chained together.
* @see Order
*/
Builder order(Order order);
/**
* Optional. Provide a queue name to get back only jobs from that queue.
*
* @param queue
* Optional. Provide a queue name to get back only jobs from that queue.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder queue(String queue);
/**
* Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
*
* @param status
* Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
* @see JobStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
Builder status(String status);
/**
* Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
*
* @param status
* Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
* @see JobStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
Builder status(JobStatus status);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends MediaConvertRequest.BuilderImpl implements Builder {
private Integer maxResults;
private String nextToken;
private String order;
private String queue;
private String status;
private BuilderImpl() {
}
private BuilderImpl(ListJobsRequest model) {
super(model);
maxResults(model.maxResults);
nextToken(model.nextToken);
order(model.order);
queue(model.queue);
status(model.status);
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final String getOrder() {
return order;
}
public final void setOrder(String order) {
this.order = order;
}
@Override
public final Builder order(String order) {
this.order = order;
return this;
}
@Override
public final Builder order(Order order) {
this.order(order == null ? null : order.toString());
return this;
}
public final String getQueue() {
return queue;
}
public final void setQueue(String queue) {
this.queue = queue;
}
@Override
public final Builder queue(String queue) {
this.queue = queue;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(JobStatus status) {
this.status(status == null ? null : status.toString());
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 ListJobsRequest build() {
return new ListJobsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}